Skip to content

REST API

The `/v1` reference, generated from the running server.

The machine-readable spec

OpenAPI

https://api.askdeck.ai/v1/openapi.json

This is generated from the running server, so it can never describe an endpoint we do not serve. Point your client generator at it.

The shape of every call

  • Base URL https://api.askdeck.ai/v1.
  • Authorization: Bearer <your key> on every request.
  • JSON in, JSON out. Errors are RFC 9457 problem+json.
  • Creation endpoints answer 202 with a task envelope; reads answer 200.

The task envelope

Every deck and video operation answers with the same envelope, so one parser handles all of them.

FieldMeaning
taskIdOpaque handle. Do not parse it; it is not a database id.
statusOne of working, input_required, completed, failed, cancelled.
statusMessageA human-readable line safe to show a user.
pollIntervalMsHow often to poll. 5000.
ttlMsHow long the handle stays valid. 86400000.
ai.askdeck/*Our extensions — download URL, error, resume URL. Fields may be added; existing ones are never removed without notice on the changelog.