Skip to main content

Authentication and workspaces

Generate an API token from your dashboard profile and send it in the Authorization header. Keep tokens in your application's secret store. Do not put privileged tokens into browser bundles, source control, or shared logs.

curl 'https://api.upon-ai.com/api/v1/workspaces' \
  -H "Authorization: Bearer $UPONAI_API_TOKEN"

The response contains the workspaces accessible to your identity. Use the returned id as workspaceId on workspace-scoped operations. Supplying another workspace ID does not grant access.

curl 'https://api.upon-ai.com/api/v1/agents?workspaceId=42' \
  -H "Authorization: Bearer $UPONAI_API_TOKEN"

Replace 42 with your workspace ID. Check each endpoint for whether workspace context belongs in the query or JSON body. Some call operations infer the workspace from an existing agent or call.

Try requests in the API reference​

Open an endpoint, enter your customer API token in the authorization field, and fill in its path, query, or body fields. Choose Send API Request to see the HTTP status, response headers, and response body. Copy the generated curl example or select another language. The UponAI SDK example follows your request fields.

Your token stays in memory for the current page and is not saved to local or session storage. It is sent directly to https://api.upon-ai.com; dashboard cookies are omitted. Generated request snippets mask the authorization token. Use a test workspace: these are real API requests. Operations that change data require the live-request confirmation checkbox. The browser explorer limits requests and responses to 5 MiB and times out after 30 seconds. Use the SDK or curl for larger payloads. Reload the page to clear credentials and responses.

The SDK remains a release candidate until its npm release is announced.