Docs menu: Meta

Meta

This API's own description.

On this page

Fetch this OpenAPI document

Fetch this OpenAPI document #

GET /api/v1/openapi.json

Returns the OpenAPI 3.1 description of this API, the same file the SDKs are generated from. Public, because a client needs the spec before it can authenticate.

Public, no key

Request

curl

curl -X GET 'https://tallio.dev/api/v1/openapi.json'

TypeScript SDK

import { createTallioClient, unwrap } from "@tallio/sdk";

const tallio = createTallioClient({
  apiKey: process.env.TALLIO_API_KEY!,
  baseUrl: "https://tallio.dev",
});

const result = await unwrap(tallio.http.GET("/api/v1/openapi.json"));

Responses
Status	Description
`200`	The OpenAPI document.
4XX, 5XX	An error: see Errors below.

Response body · 200

openapistringrequired

The OpenAPI version, 3.1.0.

infoobjectrequired

Title, version and overview of the API.

Show nested fields (2)

titlestringrequired: The API's name.
versionstringrequired: The API version.

pathsobjectrequired

Every operation, by path and method.

Show nested fields (1)

{key}any

componentsobjectrequired

Shared schemas, responses, parameters and headers.

Show nested fields (1)

{key}any

Example response · 200

{
  "openapi": "string",
  "info": {
    "title": "string",
    "version": "string"
  },
  "paths": {},
  "components": {}
}

Response headers

x-request-idstring: The request's correlation id; quote it when reporting a problem. One of: req_ plus a uuid (Tallio made it), client: plus the x-request-id you sent (8-128 of A-Z a-z 0-9 . _ : -), or the hosting platform's id.
With every response
Show patternHide pattern
^(?:req_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|client:[A-Za-z0-9._:-]{8,128}|[A-Za-z0-9._-]{1,16}::[A-Za-z0-9._:-]{6,110})$
retry-afterinteger: Seconds to wait before retrying a request refused with 429 rate_limited.
With 429 · At least 1
ratelimit-limitinteger: Requests allowed in the current window for the bucket this request counted against.
With 429 · At least 1
ratelimit-remaininginteger: Requests left in the current window; 0 means the next one is refused until the window resets.
With 429 · At least 0
ratelimit-resetinteger: Seconds until the current window resets.
With 429 · At least 0

Errors
Code	Status	Retryable	Meaning
`rate_limited`	429	Yes	A rate limit was reached. Retry later.
`internal_error`	500	No	An unexpected server error occurred.