Skip to content

Add an API

POST
/v1/apis
curl --request POST \
--url https://beta-api.plune.ai/v1/apis \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "Shop API" }'

A person, or a write token without X-Plune-Session; an agent names the API its endpoint is for and adds none (403 agent_proposes). A name is the project’s once, whatever its case (409 api_exists); a project holds at most 50 (409 api_limit). The first endpoint written into a project with no API makes one, named API. Logged as an update of the project.

Media type application/json
object
name
required
string
>= 1 characters <= 100 characters
Example
{
"name": "Shop API"
}

The API

Media type application/json

An API of the project’s catalog (#2398): catalog, API, endpoints.

object
id
required
string
projectId
required
string
name
required

The project’s once, whatever its case

string
endpoints
required

How many endpoints it holds

integer
createdBy
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{
"id": "4b6f3c1e-8d2a-4f5b-9c7e-1a2b3c4d5e6f",
"projectId": "u-shop::default",
"name": "Shop API",
"endpoints": 0,
"createdBy": "6f1c2b3a-0000-4000-8000-0000000000a2",
"createdAt": "2026-11-04T09:00:00.000Z",
"updatedAt": "2026-11-04T09:00:00.000Z"
}

Invalid JSON or body

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

No / invalid token or session

A reader, a read token, or an agent (agent_proposes)

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

The project has an API of this name (api_exists), or as many as it may hold (api_limit)

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

Rate-limited: the per-route throttle, or the per-minute request limit of the plan an API token counts by (#1442; the body names the plan, #2092). Retry-After carries the seconds until the window rolls over.

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}
Retry-After
integer

Seconds until the window rolls over