Skip to main content
Use the Counso API definitions to inspect request and response schemas, or import the collection into Postman to work with individual requests.

​
Use the collection

  1. Open Postman, select Import, and import the collection and environment files.
  2. Select the Counso environment. Its baseUrl is https://app.counso.ai; change it only when connecting to another Counso deployment. Enter the target workspaceId.
  3. Add your credential as a local secret value: apiKey for workspace API requests, or userAccessToken for requests that act as a signed-in user. The shared environment contains no credentials.
  4. Choose a request, fill in its path parameters and body, then send it. Start with a read request, such as listing Agents, to check the workspace and connection.
The collection groups requests by authentication: Postman also accepts a URL during import. To use that option, copy the raw download URL of the collection or environment file above. Before sending a request, check its workspace, credentials and body; write operations change the selected workspace.