Endpoints

REST endpoints for endpoints. Bearer-auth required.

GET /api/endpoints

List endpoints.

Query parameters

limit (optional): Page size (1–100, default 100).
after (optional): Keyset cursor — return the page after this row (next page).
before (optional): Keyset cursor — return the page before this row (prev page).
ids (optional): Comma-separated list of IDs. Narrows results to these IDs within the caller's accessible scope (does not bypass access checks).
filter (optional): Nested filter expression (<Entity>Filter): AND/OR/NOT + per-field comparison operators + relation traversal. JSON-encoded on the query string.
orderBy (optional): Multi-key sort (<Entity>OrderBy[]): array of { field: direction } applied in order. Directions: asc/desc plus the four explicit nulls variants. JSON-encoded on the query string.
api_id (optional): Filter to endpoints under this api.
workspace_id (optional): Filter to endpoints in this workspace.
include_deleted (optional): Soft-deleted endpoint visibility. false (default) — active rows only. true — active plus soft-deleted. only — soft-deleted only (trash view).
method (optional): Shorthand: filter where method equals this value.
handler_type (optional): Shorthand: filter where handlerType equals this value.
enabled (optional): Shorthand: filter where enabled equals this value.

Response

JSON

{
  "data": [
    {
      "id": "<...>",
      "apiId": "<...>",
      "method": "<...>",
      "path": "<...>",
      "handlerType": "<...>",
      "handlerId": "<...>",
      "auth": "<...>",
      "cors": "<...>",
      "timeoutSeconds": "<...>",
      "enabled": "<...>",
      "createdAt": "<...>",
      "updatedAt": "<...>"
    }
  ],
  "pageInfo": {
    "total": "number",
    "hasNextPage": "boolean",
    "hasPreviousPage": "boolean",
    "startCursor": "string",
    "endCursor": "string"
  }
}

POST /api/endpoints

Create endpoint

Request body

JSON

{
  "apiId": "string",
  "method": "GET | POST | PUT | PATCH",
  "path": "string",
  "handlerType": "function | workflow | agent | swarm",
  "handlerId": "string",
  "auth?": "any",
  "cors?": {
    "allowOrigins": ["<...>"],
    "allowCredentials?": "boolean"
  },
  "timeoutSeconds?": "integer",
  "enabled?": "boolean"
}

Response

JSON

{
  "id": "string",
  "apiId": "string",
  "method": "GET | POST | PUT | PATCH",
  "path": "string",
  "handlerType": "function | workflow | agent | swarm",
  "handlerId": "string",
  "auth": "any",
  "cors": {
    "allowOrigins": ["<...>"],
    "allowCredentials?": "boolean"
  },
  "timeoutSeconds": "integer",
  "enabled": "boolean",
  "createdAt": "string",
  "updatedAt": "string"
}

GET /api/endpoints/{id}

Get an endpoint by ID.

Path parameters

id (required): Endpoint to retrieve.

Response

JSON

{
  "id": "string",
  "apiId": "string",
  "method": "GET | POST | PUT | PATCH",
  "path": "string",
  "handlerType": "function | workflow | agent | swarm",
  "handlerId": "string",
  "auth": "any",
  "cors": {
    "allowOrigins": ["<...>"],
    "allowCredentials?": "boolean"
  },
  "timeoutSeconds": "integer",
  "enabled": "boolean",
  "createdAt": "string",
  "updatedAt": "string"
}

PATCH /api/endpoints/{id}

Update endpoint

Path parameters

id (required): The endpoint's prefixed ID.

Request body

JSON

{
  "method?": "GET | POST | PUT | PATCH",
  "path?": "string",
  "handlerType?": "function | workflow | agent | swarm",
  "handlerId?": "string",
  "auth?": "any",
  "cors?": {
    "allowOrigins": ["<...>"],
    "allowCredentials?": "boolean"
  },
  "timeoutSeconds?": "integer",
  "enabled?": "boolean"
}

Response

JSON

{
  "id": "string",
  "apiId": "string",
  "method": "GET | POST | PUT | PATCH",
  "path": "string",
  "handlerType": "function | workflow | agent | swarm",
  "handlerId": "string",
  "auth": "any",
  "cors": {
    "allowOrigins": ["<...>"],
    "allowCredentials?": "boolean"
  },
  "timeoutSeconds": "integer",
  "enabled": "boolean",
  "createdAt": "string",
  "updatedAt": "string"
}

DELETE /api/endpoints/{id}

Soft-delete an endpoint.

Path parameters

id (required): Endpoint to soft-delete.

Response

JSON

{
  "success": "boolean"
}

DELETE /api/endpoints/{id}/purge

Permanently delete a soft-deleted endpoint.

Path parameters

id (required): Soft-deleted endpoint to permanently delete.

Response

JSON

{
  "success": "boolean"
}

POST /api/endpoints/{id}/restore

Restore a soft-deleted endpoint.

Path parameters

id (required): Soft-deleted endpoint to restore.

Response

JSON

{
  "id": "string",
  "apiId": "string",
  "method": "GET | POST | PUT | PATCH",
  "path": "string",
  "handlerType": "function | workflow | agent | swarm",
  "handlerId": "string",
  "auth": "any",
  "cors": {
    "allowOrigins": ["<...>"],
    "allowCredentials?": "boolean"
  },
  "timeoutSeconds": "integer",
  "enabled": "boolean",
  "createdAt": "string",
  "updatedAt": "string"
}