Skip to main content

Other Resources

Quick reference for the remaining /api/v1 resources. Each links to the Core Concepts page with full conceptual detail and field tables.

Connectors

EndpointDescription
GET /api/v1/connectorsList all available connectors and their actions/auth requirements.
GET /api/v1/connectors/{name}Detail for one connector — actions, parameters, required credential fields.

Secrets

EndpointAuthDescription
GET /api/v1/secretsanyList secret names for the tenant (values are never returned).
POST /api/v1/secretsadmin/ownerCreate/update a named secret — {"name": "OPENAI_API_KEY", "value": "sk-..."}. AES-256-GCM encrypted at rest.
DELETE /api/v1/secrets/{name}admin/ownerDelete a secret.

See Secrets & Credentials — Encryption.

OAuth connections

Browser-redirect flows (public, no JWT — the browser can't send Authorization headers):

EndpointDescription
GET /api/v1/oauth/google/authorize / .../callbackGoogle connector OAuth (Sheets, Calendar, Gmail, Drive).
GET /api/v1/oauth/notion/authorize / .../callbackNotion connector OAuth.
GET /api/v1/oauth/slack/authorize / .../callbackSlack connector OAuth.

Authenticated management:

EndpointDescription
GET /api/v1/oauth/statusWhich OAuth providers are configured platform-wide.
GET /api/v1/oauth/connectionsList the tenant's connected accounts.
DELETE /api/v1/oauth/connections/{id}Disconnect an account.
GET /api/v1/oauth/connections/{id}/tokenGet a fresh access token (refreshes if expired).
POST /api/v1/oauth/connections/{id}/refreshForce-refresh a token.
POST /api/v1/connectionsCreate a manual API-key-based connection (for connectors without OAuth, e.g. {"connector": "github", "credentials": {"token": "..."}}).

See Secrets & Credentials — OAuth connections.

Knowledge Bases

EndpointDescription
GET /api/v1/knowledge-basesList KBs.
POST /api/v1/knowledge-basesCreate a KB (embedding provider/model config).
GET /api/v1/knowledge-bases/{id}Get KB detail.
DELETE /api/v1/knowledge-bases/{id}Delete a KB and its documents/chunks.
GET /api/v1/knowledge-bases/{id}/documentsList documents.
POST /api/v1/knowledge-bases/{id}/documentsAdd a document by URL/text.
POST /api/v1/knowledge-bases/{id}/documents/uploadUpload a file (PDF, DOCX, etc.) for chunking + embedding.
DELETE /api/v1/knowledge-bases/{id}/documents/{docId}Remove a document and its chunks.
POST /api/v1/knowledge-bases/{id}/querySemantic search — {"query": "...", "top_k": 5}.

See Knowledge Bases.

Skills

EndpointDescription
GET /api/v1/skillsList the tenant's skills.
GET /api/v1/skills/publishedList skills published to the public registry.
POST /api/v1/skillsCreate a skill (SKILL.md + scripts/references).
POST /api/v1/skills/parseParse an uploaded skill bundle (zip) into a structured skill.
GET /api/v1/skills/registry/search?q=Search the public skill registry.
POST /api/v1/skills/registry/installInstall a registry skill into the tenant.
GET /api/v1/skills/{id} / PUT / DELETEGet/update/delete a skill.
POST /api/v1/skills/{id}/publish / unpublishPublish/unpublish a skill to the registry.

See Skills.

Team

EndpointAuthDescription
GET /api/v1/team/membersadmin/ownerList tenant members and roles.
POST /api/v1/team/inviteadmin/ownerInvite a member by email with a role.
PUT /api/v1/team/members/{id}/roleownerChange a member's role.
DELETE /api/v1/team/members/{id}ownerRemove a member.

See Teams, Organizations & Roles — User roles.

Organizations (Enterprise)

EndpointDescription
POST /api/v1/organizationsCreate an organization.
GET /api/v1/organizationsList organizations.
GET /api/v1/organizations/{id}Get organization detail (member tenants).
POST /api/v1/organizations/{id}/tenants/{tenantId}Assign a tenant to an organization.

See Teams, Organizations & Roles — Organizations.

Billing

EndpointAuthDescription
GET /api/v1/billing/plansanyList the plan ladder (Free/Pro/Enterprise) with limits.
GET /api/v1/billing/subscriptionanyCurrent subscription/plan for the tenant.
POST /api/v1/billing/checkoutownerCreate a Stripe Checkout session to upgrade.
POST /api/v1/billing/portalownerCreate a Stripe Customer Portal session.

See Billing & Plans.

SSO config (Enterprise)

EndpointAuthDescription
GET /api/v1/sso/configownerGet the tenant's SAML/OIDC configuration.
PUT /api/v1/sso/configownerCreate/update SSO configuration.
DELETE /api/v1/sso/configownerRemove SSO configuration.

See Teams, Organizations & Roles — SSO. Login-time SSO routes are public — see Authentication.

Misc

EndpointDescription
GET /api/v1/llm/models?provider=&api_key=&base_url=List available models for an LLM provider (used to populate model dropdowns in the agent/LLM node config). Accepts a {{ secret.NAME }} reference for api_key.
POST /api/v1/playground/runRun a single LLM prompt without a workflow — see Deploying Workflows — Prompt Playground.
POST /api/v1/test/telegramSend a test message to verify a Telegram bot token/chat ID.
GET /api/v1/system/workersadmin/owner — Temporal worker pool status.