Refabric Docs

For AI agents: this page is also available as Markdown at https://docs.refabric.com/api-reference/platform/tasks/read-a-tasks-openapi-document.md, and the index of every page is https://docs.refabric.com/llms.txt.

Platform API › Tasks

Read a task's OpenAPI document

One task's own OpenAPI document: running it, estimating it, its examples and its job and result reads, with the task's input and output as named schemas.

GEThttps://api.refabric.com/v1/tasks/{name}/openapi.json
import requests

url = "https://api.refabric.com/v1/tasks/{name}/openapi.json"

response = requests.get(url)

print(response.json())
null

Authentication. No key: a task's document is the same for every reader.

Common use cases

  • Generate a typed client or a tool definition for one task.
  • Validate a request against the task's input schema before you send it.

Conflicts. A task that was removed answers 410 task_removed; an unknown name 404.

See also

  • GET /v1/tasks/{name}
  • GET /v1/openapi.json

Authorization

No key needed.

Parameters

Path parameters

  • stringrequired

Header parameters

  • stringoptional

    The contract version you wrote against (a date). Absent: the current version.

    format: date

  • stringoptional

    Your own id for this request; we answer it back under X-Client-Request-ID.

    max length 128

Response

200 — Done: the answer is in the body.

    • 401 — No valid API key was sent.
    • 403 — Your key or your plan does not allow this.
    • 404 — Nothing has this address.
    • 410 — This was removed.
    • 429 — Too many requests: wait for the number of seconds in the Retry-After header.
    • 500 — Something went wrong on our side; retry, and quote the request id if it keeps happening.