Factory.ai Logo

AutoWiki API

Generate and manage AutoWiki runs: create runs, browse pages, search, and export.

GET/api/v0/wiki

List the latest wiki runs

Returns the most recent wiki generation runs available to the authenticated organization.

cURL
curl 'https://api.factory.ai/api/v0/wiki' \
  -H 'Authorization: Bearer $FACTORY_API_KEY'

Responses

200Response for status 200
401Response for status 401
detailstringrequired

Human-readable error message

statusnumberrequired

HTTP status code

titlestringrequired

HTTP status title

metadataobject (map)

Additional error metadata

Values

500Response for status 500
detailstringrequired

Human-readable error message

statusnumberrequired

HTTP status code

titlestringrequired

HTTP status title

metadataobject (map)

Additional error metadata

Values

POST/api/v0/wiki

Create a wiki run

Starts a wiki generation run for a connected repository.

cURL
curl -X POST 'https://api.factory.ai/api/v0/wiki' \
  -H 'Authorization: Bearer $FACTORY_API_KEY'

Responses

200Response for status 200
401Response for status 401
detailstringrequired

Human-readable error message

statusnumberrequired

HTTP status code

titlestringrequired

HTTP status title

metadataobject (map)

Additional error metadata

Values

500Response for status 500
detailstringrequired

Human-readable error message

statusnumberrequired

HTTP status code

titlestringrequired

HTTP status title

metadataobject (map)

Additional error metadata

Values

GET/api/v0/wiki/history/{repoUrl}

List wiki run history for a repository

Returns wiki generation history for the repository identified by its URL.

cURL
curl 'https://api.factory.ai/api/v0/wiki/history/{repoUrl}' \
  -H 'Authorization: Bearer $FACTORY_API_KEY'

Parameters

repoUrlstringpathrequired

Responses

200Response for status 200
401Response for status 401
detailstringrequired

Human-readable error message

statusnumberrequired

HTTP status code

titlestringrequired

HTTP status title

metadataobject (map)

Additional error metadata

Values

500Response for status 500
detailstringrequired

Human-readable error message

statusnumberrequired

HTTP status code

titlestringrequired

HTTP status title

metadataobject (map)

Additional error metadata

Values

POST/api/v0/wiki/video-upload-url

Create a wiki video upload URL

Creates a temporary upload URL for a generated wiki video.

cURL
curl -X POST 'https://api.factory.ai/api/v0/wiki/video-upload-url' \
  -H 'Authorization: Bearer $FACTORY_API_KEY'

Responses

200Response for status 200
401Response for status 401
detailstringrequired

Human-readable error message

statusnumberrequired

HTTP status code

titlestringrequired

HTTP status title

metadataobject (map)

Additional error metadata

Values

500Response for status 500
detailstringrequired

Human-readable error message

statusnumberrequired

HTTP status code

titlestringrequired

HTTP status title

metadataobject (map)

Additional error metadata

Values

GET/api/v0/wiki/{wikiRunId}

Get a wiki run

Returns the status and output metadata for a wiki generation run.

cURL
curl 'https://api.factory.ai/api/v0/wiki/{wikiRunId}' \
  -H 'Authorization: Bearer $FACTORY_API_KEY'

Parameters

wikiRunIdstringpathrequired

Responses

200Response for status 200
401Response for status 401
detailstringrequired

Human-readable error message

statusnumberrequired

HTTP status code

titlestringrequired

HTTP status title

metadataobject (map)

Additional error metadata

Values

500Response for status 500
detailstringrequired

Human-readable error message

statusnumberrequired

HTTP status code

titlestringrequired

HTTP status title

metadataobject (map)

Additional error metadata

Values

DELETE/api/v0/wiki/{wikiRunId}

Delete a wiki run

Deletes the wiki generation run identified by its ID.

cURL
curl -X DELETE 'https://api.factory.ai/api/v0/wiki/{wikiRunId}' \
  -H 'Authorization: Bearer $FACTORY_API_KEY'

Parameters

wikiRunIdstringpathrequired

Responses

200Response for status 200
401Response for status 401
detailstringrequired

Human-readable error message

statusnumberrequired

HTTP status code

titlestringrequired

HTTP status title

metadataobject (map)

Additional error metadata

Values

500Response for status 500
detailstringrequired

Human-readable error message

statusnumberrequired

HTTP status code

titlestringrequired

HTTP status title

metadataobject (map)

Additional error metadata

Values

GET/api/v0/wiki/{wikiRunId}/export

Export a wiki run as a zip

Downloads the generated wiki files for a run as a ZIP archive.

cURL
curl 'https://api.factory.ai/api/v0/wiki/{wikiRunId}/export' \
  -H 'Authorization: Bearer $FACTORY_API_KEY'

Parameters

wikiRunIdstringpathrequired

Responses

200Response for status 200
401Response for status 401
detailstringrequired

Human-readable error message

statusnumberrequired

HTTP status code

titlestringrequired

HTTP status title

metadataobject (map)

Additional error metadata

Values

500Response for status 500
detailstringrequired

Human-readable error message

statusnumberrequired

HTTP status code

titlestringrequired

HTTP status title

metadataobject (map)

Additional error metadata

Values

GET/api/v0/wiki/{wikiRunId}/pages/{pageId}

Get a wiki page

Returns one generated page from a wiki run.

cURL
curl 'https://api.factory.ai/api/v0/wiki/{wikiRunId}/pages/{pageId}' \
  -H 'Authorization: Bearer $FACTORY_API_KEY'

Parameters

wikiRunIdstringpathrequired
pageIdstringpathrequired

Responses

200Response for status 200
401Response for status 401
detailstringrequired

Human-readable error message

statusnumberrequired

HTTP status code

titlestringrequired

HTTP status title

metadataobject (map)

Additional error metadata

Values

500Response for status 500
detailstringrequired

Human-readable error message

statusnumberrequired

HTTP status code

titlestringrequired

HTTP status title

metadataobject (map)

Additional error metadata

Values

POST/api/v0/wiki/{wikiRunId}/privacy

Update wiki run privacy level

Updates the privacy level for a generated wiki.

cURL
curl -X POST 'https://api.factory.ai/api/v0/wiki/{wikiRunId}/privacy' \
  -H 'Authorization: Bearer $FACTORY_API_KEY'

Parameters

wikiRunIdstringpathrequired

Responses

200Response for status 200
401Response for status 401
detailstringrequired

Human-readable error message

statusnumberrequired

HTTP status code

titlestringrequired

HTTP status title

metadataobject (map)

Additional error metadata

Values

500Response for status 500
detailstringrequired

Human-readable error message

statusnumberrequired

HTTP status code

titlestringrequired

HTTP status title

metadataobject (map)

Additional error metadata

Values