Help › Api · version 2 ·
HistoryMarkdown
tags
#help #api #routes #developers
description
The API index in AI Putty lists every API route by section with its feature and error codes, a filter, a live health line and a ready curl example.
brief
The API index at /api lists every API route, section by section, with what each does and the error codes it can return. Filter it, check health, and copy a Try it example.

Find an API route and its error codes✎ edit

API index lists every route of the AI Putty API, section by section, in a fixed order. Each route shows its feature, the error codes it can refuse with, and a note on what it does. How to use the pages themselves is in Help.

The API index✎ edit

  • The health line at the top: Healthy or Unhealthy, then the project's topics and classes, each a link to read it from the API. If it can't be checked, it says Live status unavailable and why.
  • Sections: each has a heading and a list of routes. A route shows its method and path (for example GET /api/v2/health), any query fields and body, then its feature and its codes.
  • Live links: a GET route with nothing to fill in is a link. Tap it to see its answer.
  • Codes: each code (such as E_TAKEN) links to its line in the error list, which says what it means.

Filter the routes✎ edit

Type in Filter by feature, word or code. A route stays when its feature matches a word you typed, one of its codes matches, or its text contains the word. Type several words to narrow it further: a route must match each. A section with no match left is hidden.

Try it✎ edit

Under Try it is a ready curl command for this site. It sends a tiny spec and a story to the run route and checks the answer. Put your own token where it says $D2_TOKEN.

Who may call what✎ edit

  • Writes (PUT, POST, DELETE) need a bearer token. Make one on AI tokens. What a read returns depends on who you are: a project's members see more than a visitor.
  • Log in, sign up, members, tokens and the account pages are HTML forms on the pages, not API calls.

Examples✎ edit

  • "My AI got E_TAKEN. What does it mean?" Type E_TAKEN in the filter. You see every route that can return it; tap the code to read its line in the error list.
  • "Which routes deal with releases?" Type release. Only routes with that feature or word stay.
  • "Is the site up right now?" Read the health line at the top: Healthy means the health check passed.
  • "How do I test my token from a terminal?" Copy the Try it command, put your token in place of $D2_TOKEN, and run it.

Good to know✎ edit

  • Where does the error list live? Each code's link opens its line there.
  • Why can't I tap a route? Only a GET with nothing to fill in is a link. For the rest, use a tool such as curl.
  • Related: AI tokens, Security, Settings.