operations

create_parse_content_download

Changed on

Start or poll Markdown generation; return a download grant when ready.

post/v1/jobs/{job_id}/content-download

Request

  • Base URL
    https://ndi-api.nace.ai
  • Auth
    API key in header X-API-Key

Path parameters

job_idstring uuid required

Job identifier.

Query parameters

sheet_namestring nullable

Sheet name; omit for document content.

retryboolean

Restart a failed Markdown export.

Response

Successful Response

status'pending' | 'ready' | 'failed'

Export state; pending requests should be polled again.

urlstring nullable

Signed download URL when ready. Treat it as a temporary credential.

expires_atinteger nullable

Expiry of the ready download grant, as Unix epoch seconds.

retry_after_secondsinteger nullable

Suggested delay before polling a pending export.

errorstring nullable

Safe export failure explanation, when failed.

Changes

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status