Exports

Start an export job

Start an asynchronous export of a corpus — documentation, FAQ, or releases — as markdown or JSON. Returns 202 Accepted with a Location header and a Retry-After hint rather than blocking, so a large export never holds a connection open. Poll the job with getExport until its status is 'completed'.

post/exports

Request

  • Base URL: https://yappy.biz/api/v1
  • URL: https://yappy.biz/api/v1/exports
  • Auth: one of:
    • none
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://yappy.biz/oauth/authorize, token URL https://yappy.biz/oauth/token; client credentials, token URL https://yappy.biz/oauth/token, scopes: export:docs)

Headers

Idempotency-Keystring

A client-chosen key that makes a retry return the original result instead of starting a second job. Echoed back on the response.

Request body

resource'docs' | 'faq' | 'releases' required

Which corpus to export.

format'markdown' | 'json'

The artifact format.

Response

The job was accepted and is being prepared

object'job' required

Type discriminator.

idstring required

Job identifier.

status'queued' | 'running' | 'completed' | 'failed' required

Where the job is now.

resourcestring required

What is being exported.

formatstring

The artifact format.

created_atstring date-time

When it was accepted.

poll_urlstring uri required

Where to poll this job.

retry_afterinteger

Seconds to wait before polling again.

errorobject nullable

Present once status is failed.

Changes

No recorded changes to this operation across all 1 revision of this API.