Tellagen
← Back to Support Center

Use the public API reference

Find an endpoint contract, identify its scope, and build an authenticated request.

GuideLast verified Open Markdown version
On this page

Before you start

Intended audience

Developers and operators who integrate with the Tellagen HTTP API.

Required permissions

Anyone can read the API Reference. API requests need a key with the endpoint's Scope.

Prerequisites

  • Know the operation that the integration must perform.

Procedure

Find the contract

  1. Step 1 of 8

    Open the reference

    Open the API reference. You do not need an API key to read it.

  2. Step 2 of 8

    Search endpoints

    Use Find an endpoint. Search by path or purpose.

  3. Step 3 of 8

    Filter the results

    Use Method and Scope to narrow the endpoint list.

  4. Step 4 of 8

    Read the contract

    Open an endpoint. Read its scope, example request, and success status. Expand the contract for field rules and Errors and recovery for failures.

    API Reference endpoint finder and an incident endpoint contract with its required scope.
    Use the endpoint finder, then read the Scope in the selected contract. Open full-size image(opens in a new tab)

  5. Step 5 of 8

    Use the Markdown index

    Open the Markdown endpoint index. Use its links to open endpoint details.

Call the API

  1. Step 6 of 8

    Create a scoped key

    Create and store a scoped API key with the endpoint's Scope.

  2. Step 7 of 8

    Send a safe test request

    Send GET /api/v1/incidents with the header Authorization: Bearer tllg_YOUR_TOKEN. A successful request returns 200 OK and a JSON incident list.

    Safe request with placeholders

    shell
    curl 'https://YOUR_WORKSPACE.api.tellagen.com/api/v1/incidents' \
  -H 'Authorization: Bearer tllg_YOUR_TOKEN' \
  -H 'Accept: application/json'

  3. Step 8 of 8

    Review the response

    Compare the status and response body with the documented contract. Handle documented errors explicitly.

You are done when…

The request uses the documented path and minimum scope, and its response matches the endpoint contract.

Troubleshooting

The API returns a scope error.

Create a replacement key with the exact scope shown for that endpoint. Store it before revoking the old key.

The Markdown reference differs from the HTML page.

Treat the generated reference as one canonical source and report a contract mismatch before building against it.

The API returns an authentication error.

Make sure that the token is active. Retry the read-only request with Bearer tllg_YOUR_TOKEN. The request does not change incident data. If authentication still fails, ask a workspace manager to review the key.

The endpoint is hard to find.

Clear the filters. Search by a stable path term such as incidents, timeline, or postmortems.

Related articles