For the complete documentation index, see llms.txt. This page is also available as Markdown.

GET /api/v1/status/{job_id}

GET /api/v1/status/{job_id} endpoint reference.

Purpose

Return the current state of a generation job created with the same API key. When status is completed, the response includes short-lived download URLs for .pptx output.

Request

Item
Value

Method and path

GET {PERCEPTIS_API_BASE_URL}/api/v1/status/{job_id}

Auth

Authorization: Bearer <api-key>

Path parameter

job_id from the generate response

Status values

Status
Meaning

pending

The job has been accepted.

processing

The job is being generated.

completed

The PowerPoint output is ready to download. A deck can hold fewer slides than you asked for. Read downloads[0].slide_count for the number in the file.

failed

Generation failed. See the error object.

Responses

HTTP
Meaning

200

Status payload returned.

401

Missing, invalid, or revoked API key.

403

Organization is not eligible for API access. Perceptis API usage requires a paid Business or Enterprise plan; Free, Starter, and trial organizations are not eligible.

404

Unknown job, or the job was not created with this API key.

429

Polling too quickly. Use Retry-After and back off.

Example completed response:

Download URLs are short-lived. For completed jobs, poll this endpoint again whenever you need fresh links. Downloads can be refreshed while the generated files remain available, but only with the same API key that created the job.

See also

Last updated

Was this helpful?