Bird provides communication APIs and a workspace-scoped platform API; the workspace endpoint reads the current key's workspace identity and settings.

API

What your agent can do

  • Returns the workspace the current credentials are scoped to

    Via API.

Tasks depend on the interface and permissions.

Connection methods

Choose a route that fits your agent.

API connection
API path
https://us1.platform.bird.com/v1/workspace

Authentication
Workspace API keys authenticate requests to the Bird API as bearer tokens.
Permissions
workspace:read

Documentation & experience

  • 1 connection path
View sources and checks
How documentation is checked