For the complete documentation index, see llms.txt. This page is also available as Markdown.

Tabnine APIs

Consolidated API reference for Tabnine Enterprise

Tabnine API Reference

Use these APIs to query usage, retrieve audit data, and automate administration.

This page renders the latest unified OpenAPI spec.

It includes current endpoints and supported legacy endpoints.

Authentication

All APIs return JSON.

Authenticate with a Personal Access Token in the Authorization: Bearer <token> header.

Any user can create a Personal Access Token.

  1. Go to SettingsAccess Tokens.

  2. Click Generate Token.

  3. Enter a name and expiration.

  4. Under Token access, select the permissions the token needs (see Token scopes).

  5. Copy the token before closing the dialog.

Generate a new token in the Access Tokens section

If you lose a token, revoke it and generate a new one.

See Personal Access Tokens for token management.

Use the API for automation and Analytics (Usage Reports) for dashboard views.

Token Scopes

When you create a Personal Access Token, you choose what it can access and at what level. The token carries only the permissions you grant it — give it the minimum it needs.

A token has two kinds of scope:

  • API access — per-area permissions for the APIs on this page. Each area you enable is granted at one of:

    • Read — read-only (GET) access to that area.

    • Read + write — read plus the area's write operations (POST, PUT, PATCH, DELETE).

  • CLI / Agent access — capabilities for the Tabnine CLI and agent workflows (YOLO mode, Context Engine MCP, Coaching Guidelines MCP). These do not affect the APIs on this page.

A request succeeds only if the token grants the relevant area at the required level. A read-write operation requires a read-write grant; a read operation is satisfied by either read or read-write.

Scopes only ever restrict a token below its owner's permissions — they never grant extra access. A token can never do more than the user who created it.

YOLO mode lets the Tabnine CLI auto-approve every tool call (file writes, shell commands, MCP calls) with no review. Grant it only to tokens used in trusted, automated workflows. It is honored by the CLI rather than enforced by the API, and the organization-wide Restrict YOLO mode setting always takes precedence — if an admin has turned YOLO off for the organization, a token granted YOLO still cannot use it.

API Areas

Area
Levels
Covers

Organization

Read

Organization metadata, the list of teams, and unassigned org users

Usage metrics

Read

Organization, team, and user usage and agent-usage (v1 and v2)

Audit logs

Read

Organization audit log events

License and permissions

Read

License metadata and the permissions enabled on the instance

Users and teams

Read / Read + write

Read team and user details; write creates and renames teams

User management

Read + write

Update user roles, active status, and team assignment (including allowed teams)

Team repositories

Read / Read + write

List repository connections; write adds, updates, and removes them

Invitations

Read / Read + write

List pending invitations; write invites users and revokes invitations

Error Responses

If a token lacks the scope a request requires, the API responds with 403:

HTTP

error

Meaning

403

INSUFFICIENT_TOKEN_SCOPE

The token does not grant the area/level the endpoint requires. The body includes requiredScope.

403

ACCESS_TOKEN_NOT_PERMITTED

The endpoint is administrative and cannot be called with a Personal Access Token.

Example INSUFFICIENT_TOKEN_SCOPE body:

Usage Metrics

The Usage API provides programmatic access to usage metrics across an organization.

It is available to Enterprise SaaS and private installations.

Use v2 usage endpoints for detailed analytics.

Use v1 endpoints only for backward compatibility.

ORGANIZATIONS

Use these endpoints to retrieve organization-wide metadata and usage.

Get Current Organization

Get current organization

get
/api/v1/organization

Get current organization ID and high-level settings

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Responses
200

Organization information

application/json
idstring · uuidRequired
namestringRequired
publicKeystringOptional

Public key in PEM format

samlEnabledbooleanOptional
smtpConfiguredbooleanOptional
usernamePasswordEnabledbooleanOptional
domainsstring[]Optional
planTypestringOptional
get/api/v1/organization

Get List of Teams

List teams

get
/api/v1/organization/teams

Get list of teams for the organization

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Query parameters
offsetintegerOptionalDefault: 0
limitintegerOptionalDefault: 50
Responses
200

List of teams

application/json
get/api/v1/organization/teams

Get Account Usage Info

Get account utilization info

get
/api/v1/organization/account-utilizations

Get monthly account utilization (registered, deactivated, active, pending users)

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Query parameters
startDatestringOptional

Start date for showing utilization (YYYY-MM). Default is last 12 months.

Example: 2025-01Pattern: ^\d{4}-\d{2}$
Responses
200

Monthly utilization data

application/json
yearinteger · min: 1970Required
monthinteger · max: 11Required

Zero-based month (0=January, 11=December)

registeredintegerRequired
deactivatedintegerRequired
activeintegerRequired
pendingintegerRequired
get/api/v1/organization/account-utilizations

Get Organization Usage

Returns usage totals with chat, agent, and model breakdowns.

Get organization usage (v2)

get
/api/v2/organization/usage

Returns aggregated usage metrics for an organization with split chat/agent metrics and per-model breakdown. Replaces v1 usage endpoint.

New in 6.2:

  • Chat and agent metrics are split (separate messages, linesAdded)
  • Per-model breakdown with token counts (chat.models, agent.models)
  • ides and languages fields on per-user queries
Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Query parameters
organizationIdstring · uuidRequired
fromstring · date-timeRequired

Start of reporting interval (inclusive), ISO-8601 UTC

Example: 2025-03-23T00:00:00Z
tostring · date-timeRequired

End of reporting interval (exclusive), ISO-8601 UTC

Example: 2026-02-23T00:00:00Z
granularitystring · enumRequired

Aggregation granularity for usage data

Example: allPossible values:
Responses
200

Organization usage data (v2 format)

application/json
organizationIdstring · uuidRequired
fromstring · date-timeRequired
tostring · date-timeRequired
get/api/v2/organization/usage

Get Organization Usage (LEGACY)

Use this endpoint if you still rely on the v1 response shape.

Deprecated

Get organization usage (v1 — Legacy)

get
/api/v1/organization/usage

⚠️ LEGACY ENDPOINT — DO NOT USE FOR NEW INTEGRATIONS.

As of Tabnine 6.2, this endpoint only returns historical usage data collected before 6.2 (pre-6.2 chat interactions, useful interactions, productivity factor, etc.). It does not contain any activity from 6.2 onward and will never be updated with new data.

For all current usage data, use /api/v2/organization/usage. The v2 endpoint provides split chat/agent metrics with per-model breakdowns and is the only source of post-6.2 activity data.

Returns aggregated usage metrics for an organization over a given time range. Includes per-tool metrics for agent, chat, code completions, and instruct.

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Query parameters
organizationIdstring · uuidRequired
fromstring · date-timeRequired

Start of reporting interval (inclusive), ISO-8601 UTC

Example: 2025-03-23T00:00:00Z
tostring · date-timeRequired

End of reporting interval (exclusive), ISO-8601 UTC

Example: 2026-02-23T00:00:00Z
granularitystring · enumRequired

Aggregation granularity for usage data

Example: allPossible values:
Responses
200

Organization usage data

application/json
organizationIdstring · uuidRequired
fromstring · date-timeRequired
tostring · date-timeRequired
get/api/v1/organization/usage

Get Users NOT Assigned to Teams

Get organization users

get
/api/v1/organization/users

Get users in the organization. Can filter by team membership and active status. Use teamMember=false to get users not assigned to any team.

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Query parameters
limitintegerRequired

Maximum number of items to return

Default: 200
offsetintegerRequired

Number of items to skip

Default: 0
teamMemberbooleanOptional

Filter by team membership. Use false for unassigned users.

activebooleanOptional

Filter by active status. true=registered, false=deactivated.

Responses
200

Paginated list of users

application/json
get/api/v1/organization/users

LICENSES AND PERMISSIONS

Use these endpoints to validate entitlements and enabled permissions.

Get License Info

Returns license metadata for the current Tabnine instance.

Get license info

get
/api/v1/license

Get license information including seats, features, and settings

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Responses
200

License information

application/json
get/api/v1/license

Get Account Permissions Info

Returns the permissions enabled on this Tabnine instance.

Get account permissions

get
/api/v1/instance/permissions

Get list of users with a specific role (e.g., account admins)

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Query parameters
rolestring · enumRequiredExample: AdminPossible values:
Responses
200

Users with specified role

application/json
usernamestringRequired
organizationIdstring · uuidRequired
get/api/v1/instance/permissions

TEAMS AND USERS

Use these endpoints to retrieve team-level and user-level usage data.

Get Team Users

Get team users

get
/api/v1/team/{teamId}/users

Get paginated list of users in a team

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Path parameters
teamIdstring · uuidRequired

Team UUID

Query parameters
offsetintegerRequired
limitintegerRequired
Responses
200

Team users

application/json
get/api/v1/team/{teamId}/users

Get team usage info

Get team utilization

get
/api/v1/team/account-utilizations

Get current team utilization counts (registered, deactivated, invited)

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Query parameters
teamIdstring · uuidRequired
Responses
200

Team utilization counts

application/json
registeredintegerRequired
deactivatedintegerRequired
invitedintegerRequired
get/api/v1/team/account-utilizations

Get Team-Wide Usage

Returns usage totals with chat, agent, and model breakdowns.

Get team usage (v2)

get
/api/v2/team/usage

Returns team-level usage metrics with split chat/agent metrics and per-model breakdown. Replaces v1 team usage endpoint.

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Query parameters
organizationIdstring · uuidRequired
teamIdstring · uuidRequired
fromstring · date-timeRequired

Start of reporting interval (inclusive), ISO-8601 UTC

Example: 2025-03-23T00:00:00Z
tostring · date-timeRequired

End of reporting interval (exclusive), ISO-8601 UTC

Example: 2026-02-23T00:00:00Z
granularitystring · enumRequired

Aggregation granularity for usage data

Example: allPossible values:
Responses
200

Team usage data (v2 format)

application/json
organizationIdstring · uuidRequired
teamIdstring · uuidRequired
fromstring · date-timeRequired
tostring · date-timeRequired
get/api/v2/team/usage

Get team-wide usage (LEGACY)

Use this endpoint if you still rely on the v1 response shape.

Deprecated

Get team usage (v1 — Legacy)

get
/api/v1/team/usage

⚠️ LEGACY ENDPOINT — DO NOT USE FOR NEW INTEGRATIONS.

As of Tabnine 6.2, this endpoint only returns historical usage data collected before 6.2 (pre-6.2 chat interactions, useful interactions, productivity factor, etc.). It does not contain any activity from 6.2 onward and will never be updated with new data.

For all current usage data, use /api/v2/team/usage. The v2 endpoint provides split chat/agent metrics with per-model breakdowns and is the only source of post-6.2 activity data.

Get team-level usage metrics over a time range.

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Query parameters
organizationIdstring · uuidRequired
teamIdstring · uuidRequired
fromstring · date-timeRequired

Start of reporting interval (inclusive), ISO-8601 UTC

Example: 2025-03-23T00:00:00Z
tostring · date-timeRequired

End of reporting interval (exclusive), ISO-8601 UTC

Example: 2026-02-23T00:00:00Z
granularitystring · enumRequired

Aggregation granularity for usage data

Example: allPossible values:
Responses
200

Team usage data

application/json
organizationIdstring · uuidRequired
teamIdstring · uuidRequired
fromstring · date-timeRequired
tostring · date-timeRequired
get/api/v1/team/usage

Get User Usage

Returns per-user usage with IDE and language breakdowns.

Get user usage (v2)

get
/api/v2/user/usage

Returns per-user usage metrics with split chat/agent metrics, per-model breakdown, and IDE/language information. Replaces v1 user usage endpoint.

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Query parameters
organizationIdstring · uuidRequired
userIdstring · uuidRequired
fromstring · date-timeRequired

Start of reporting interval (inclusive), ISO-8601 UTC

Example: 2025-03-23T00:00:00Z
tostring · date-timeRequired

End of reporting interval (exclusive), ISO-8601 UTC

Example: 2026-02-23T00:00:00Z
granularitystring · enumRequired

Aggregation granularity for usage data

Example: allPossible values:
Responses
200

User usage data (v2 format)

application/json
organizationIdstring · uuidRequired
userIdstring · uuidRequired
fromstring · date-timeRequired
tostring · date-timeRequired
get/api/v2/user/usage

Get user usage (LEGACY)

Use this endpoint if you still rely on the v1 response shape.

Deprecated

Get user usage (v1 — Legacy)

get
/api/v1/user/usage

⚠️ LEGACY ENDPOINT — DO NOT USE FOR NEW INTEGRATIONS.

As of Tabnine 6.2, this endpoint only returns historical usage data collected before 6.2 (pre-6.2 chat interactions, useful interactions, productivity factor, etc.). It does not contain any activity from 6.2 onward and will never be updated with new data.

For all current usage data, use /api/v2/user/usage. The v2 endpoint provides split chat/agent metrics with per-model breakdowns and is the only source of post-6.2 activity data.

Get user-level usage metrics over a time range.

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Query parameters
organizationIdstring · uuidRequired
userIdstring · uuidRequired
fromstring · date-timeRequired

Start of reporting interval (inclusive), ISO-8601 UTC

Example: 2025-03-23T00:00:00Z
tostring · date-timeRequired

End of reporting interval (exclusive), ISO-8601 UTC

Example: 2026-02-23T00:00:00Z
granularitystring · enumRequired

Aggregation granularity for usage data

Example: allPossible values:
Responses
200

User usage data

application/json
organizationIdstring · uuidRequired
userIdstring · uuidRequired
fromstring · date-timeRequired
tostring · date-timeRequired
get/api/v1/user/usage

AUDIT LOGS

The Audit Logs API returns audit events for user management, team management, and authentication activity.

The audit log includes:

  • Performing user

  • Affected user

  • Time of change

  • Value change for each event

You can use the same mapping from the Usage Metrics API between user_id and email, and between team_id and team name.

List audit log events

get
/api/v1/organization/audit-logs

Returns a paginated list of audit log events for the organization. Supports filtering by time range, event type, actor, and resource. Can return JSON or CSV format.

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Query parameters
fromstring · date-timeOptional

Start of time range (inclusive)

tostring · date-timeOptional

End of time range (exclusive)

eventTypestringOptional

Filter by event type (e.g., team_member.added, role.assigned)

actorIdstringOptional

Filter by actor ID

actorEmailstring · emailOptional

Filter by actor email

resourceTypestringOptional

Filter by resource type (team, user, role, organization)

resourceIdstringOptional

Filter by resource ID

sortstring · enumOptional

Sort order by timestamp

Default: descPossible values:
limitinteger · min: 1 · max: 1000Optional

Maximum number of events per page

Default: 50
offsetintegerOptional

Number of items to skip

Default: 0
formatstring · enumOptional

Output format (json or csv)

Default: jsonPossible values:
Responses
200

Paginated audit log events

totalintegerOptional

Total matching items (may be approximate)

limitintegerRequired
offsetintegerRequired
get/api/v1/organization/audit-logs

USER ROLE MANAGEMENT

The User Management API automates user role management and team membership.

Permissions

Role
Assign Team
Update Role
Activate/Deactivate
Invite

Admin

✓ (all roles)

✓ (all roles)

Manager

✓ (Member, Team Lead, Manager)

✓ (Member, Team Lead, Manager)

Team Lead

Member

To use this API, you will need user and team data from the organization and team APIs above.

Team rRepositories

The Repository Management API automates repository connection management for teams.

All endpoints follow this structure:

/api/team/v1/{teamId}/connections/repositories

Only Admins have permission for this endpoint.

List Repositories

Get team repositories

get
/api/team/v1/{teamId}/connections/repositories

Retrieve all repository connections for a team. Requires Admin role.

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Path parameters
teamIdstring · uuidRequired

Team UUID

Responses
200

List of repository connections

application/json
repository_linkstringRequired

The URL or path to the repository

repo_typestring · enumRequiredPossible values:
authentication_methodstring · enumOptional

Authentication method (Git only)

Possible values:
authentication_credentials_namestringOptional

Name of credentials for authentication

view_source_link_patternstringOptional

Template pattern for source code links. Use {path} and {line}.

get/api/team/v1/{teamId}/connections/repositories

Add Repository

Add team repository

post
/api/team/v1/{teamId}/connections/repositories

Add a new repository connection to a team. Requires Admin role. Git repositories can optionally include authentication. Perforce repositories require authentication.

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Path parameters
teamIdstring · uuidRequired

Team UUID

Body
repository_linkstringRequired
repo_typestring · enumRequiredPossible values:
authentication_methodstring · enumOptional

Optional for Git, not applicable for Perforce

Possible values:
authentication_credentials_namestringOptional

Optional for Git, required for Perforce

view_source_link_patternstringOptional
Responses
200

Repository connection added

application/json
repository_linkstringRequired

The URL or path to the repository

repo_typestring · enumRequiredPossible values:
authentication_methodstring · enumOptional

Authentication method (Git only)

Possible values:
authentication_credentials_namestringOptional

Name of credentials for authentication

view_source_link_patternstringOptional

Template pattern for source code links. Use {path} and {line}.

post/api/team/v1/{teamId}/connections/repositories

Update Repository

put
/api/team/v1/{teamId}/connections/repositories/{repositoryLink}

Update an existing repository connection. Requires Admin role. All fields are optional (partial update).

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Path parameters
teamIdstring · uuidRequired

Team UUID

repositoryLinkstringRequired

The full repository link/URL

Body

All fields optional for partial update

repo_typestring · enumOptionalPossible values:
authentication_methodstring · enumOptionalPossible values:
authentication_credentials_namestringOptional
view_source_link_patternstringOptional
Responses
200

Repository connection updated

application/json
repository_linkstringRequired

The URL or path to the repository

repo_typestring · enumRequiredPossible values:
authentication_methodstring · enumOptional

Authentication method (Git only)

Possible values:
authentication_credentials_namestringOptional

Name of credentials for authentication

view_source_link_patternstringOptional

Template pattern for source code links. Use {path} and {line}.

put/api/team/v1/{teamId}/connections/repositories/{repositoryLink}

Delete Repository

delete
/api/team/v1/{teamId}/connections/repositories/{repositoryLink}

Remove a repository connection from a team. Requires Admin role.

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Path parameters
teamIdstring · uuidRequired

Team UUID

repositoryLinkstringRequired

The full repository link/URL

Responses
200

Repository connection deleted

application/json
successbooleanRequired
messagestringRequired
delete/api/team/v1/{teamId}/connections/repositories/{repositoryLink}

Field descriptions

Common fields

Field
Type
Required
Description

repo_type

string

Yes

Repository type: "git" or "perforce"

repository_link

string

Yes

Git: repository URL in SSH or HTTPS format. Perforce: depot path such as //depot/main

latest_status

string

Read-only

Current indexing status

last_indexed_successfully

string or null

Read-only

ISO 8601 timestamp of last successful indexing, or null if never indexed

Git-specific fields

Field
Type
Required
Description

authentication_method

string

Yes

"ssh" or "https"

authentication_credentials_name

string

Conditional

Required when authentication_method is "https"

view_source_link_pattern

string

No

URL pattern for viewing source code. Supports {sha}, {path}, and {line}

Perforce-specific fields

Field
Type
Required
Description

authentication_credentials_name

string

Yes

Must match an existing Perforce credential name for the team

view_source_link_pattern

string

No

Currently not used for Perforce

Status values

Status
Description

pending

Repository is queued for initial indexing

cloning

Repository is being cloned

indexing

Repository is currently being indexed

success

Repository was successfully indexed

failed

Last indexing attempt failed

Perforce depots typically skip cloning and go directly to indexing.

TEAM MANAGEMENT

Use these APIs to manage teams, users, and invitations in Tabnine Enterprise.

Create A Team

Create a team

post
/api/team/v1

Create a new team within the organization. Requires Admin or Manager role.

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Body
namestring · min: 1Required
Responses
201

Team created

application/json
idstring · uuidRequired
namestringRequired
organizationIdstring · uuidRequired
syncedGroupIdstring · nullableOptional

Optional ID of synced external group

usersCountintegerOptional
isDefaultTeambooleanOptional
post/api/team/v1

USER MANAGEMENT

Get user info

Get user info

get
/api/user/v1/{userId}

Get user details including allowed teams and primary team. Requires Admin role.

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Path parameters
userIdstring · uuidRequired

User UUID

Responses
200

User information

application/json
get/api/user/v1/{userId}

Update user properties

Update user properties

patch
/api/user/v1/{userId}

Update user role, active status, or team assignment. Requires Admin or Manager role (with role hierarchy checks). Cannot modify self, instance admins, or anonymized users.

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Path parameters
userIdstring · uuidRequired

User UUID

Body

All fields are optional; only provided fields will be updated

rolestring · enumOptionalPossible values:
activebooleanOptional
teamIdstring · uuid · nullableOptional
Responses
200

User updated

application/json
successbooleanRequired
messagestringRequired
patch/api/user/v1/{userId}

Look up user by email

Get user by email

get
/api/user/v1/by-email/{email}

Look up a user by email address. Requires Admin or Manager role. Returns 404 if user not found or belongs to different organization.

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Path parameters
emailstring · emailRequired

URL-encoded email address

Responses
200

User found

application/json
idstring · uuidRequired
usernamestringOptional
emailstring · emailRequired
rolestring · enumRequiredPossible values:
verifiedbooleanRequired
activebooleanOptional
get/api/user/v1/by-email/{email}

List user's allowed teams

List user's allowed teams

get
/api/user/v1/{userId}/allowed-teams

List teams a user is allowed to access. Requires Admin or Manager role.

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Path parameters
userIdstring · uuidRequired

User UUID

Responses
200

List of allowed teams

application/json
idstring · uuidRequired
namestringRequired
organizationIdstring · uuidRequired
syncedGroupIdstring · nullableOptional

Optional ID of synced external group

usersCountintegerOptional
isDefaultTeambooleanOptional
get/api/user/v1/{userId}/allowed-teams

Add teams to a user's allowed list

Add allowed teams to user

patch
/api/user/v1/{userId}/allowed-teams

Add teams to a user's allowed-teams list. Requires Admin or Manager role. Idempotent operation.

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Path parameters
userIdstring · uuidRequired

User UUID

Body
teamIdsstring · uuid[] · min: 1Required
Responses
200

Teams added to allowed list

No content

patch/api/user/v1/{userId}/allowed-teams

No content

Remove teams from a user's allowed list

Remove allowed teams from user

delete
/api/user/v1/{userId}/allowed-teams

Remove teams from a user's allowed-teams list. Requires Admin or Manager role.

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Path parameters
userIdstring · uuidRequired

User UUID

Body
teamIdsstring · uuid[] · min: 1Required
Responses
200

Teams removed from allowed list

No content

delete/api/user/v1/{userId}/allowed-teams

No content

Invitation management

Invite user by email

Use this endpoint to invite a user to a team by email.

Invite user to team

post
/api/invitation/v1

Invite a user by email to a team with a role. Requires Admin or Manager role (with role hierarchy checks).

Returns 201 for new invitation, 200 if user already exists.

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Body
emailstring · emailRequired
teamIdstring · uuidRequired
rolestring · enumRequiredPossible values:
Responses
200

Existing user added to team

application/json
successbooleanRequired
messagestringRequired
userExistsbooleanRequired
userIdstring · uuidRequired
post/api/invitation/v1

List pending invites

List invitations

get
/api/invitation/v1

List pending invitations, optionally filtered by team. Requires Admin or Manager role.

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Query parameters
offsetintegerRequired
limitinteger · min: 1Required
teamIdstring · uuidOptional

Filter invitations by team ID

Responses
200

Paginated invitations

application/json
get/api/invitation/v1

Revoke invites by ID

Revoke invitations

delete
/api/invitation/v1

Revoke (soft-delete) invitations by IDs. Requires Admin or Manager role (with role hierarchy checks).

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Body
invitationIdsstring · uuid[] · min: 1Required
Responses
200

Invitations revoked

application/json
revokedintegerRequired

Number of invitations revoked

delete/api/invitation/v1

Agent usage

Use these endpoints to retrieve aggregated agent usage analytics by organization, team, or user.

Get organization agent usage

Get organization-level agent usage

get
/api/v1/organization/agent-usage

Returns aggregated agent usage for an organization, including model breakdown and agent type breakdown.

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Query parameters
organizationIdstringRequired

Organization identifier.

fromstring · date-timeRequired

Start of reporting interval (inclusive), ISO-8601 UTC

Example: 2025-03-23T00:00:00Z
tostring · date-timeRequired

End of reporting interval (exclusive), ISO-8601 UTC

Example: 2026-02-23T00:00:00Z
granularitystring · enumRequired

Aggregation granularity for usage data

Example: allPossible values:
Responses
200

Organization agent usage

application/json
organizationIdstringRequired
fromstring · date-timeRequired
tostring · date-timeRequired
get/api/v1/organization/agent-usage

Get team agent usage

Get team-level agent usage

get
/api/v1/team/agent-usage

Returns aggregated agent usage for a team, including model breakdown and agent type breakdown.

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Query parameters
organizationIdstringRequired

Organization identifier.

teamIdstringRequired

Team identifier.

fromstring · date-timeRequired

Start of reporting interval (inclusive), ISO-8601 UTC

Example: 2025-03-23T00:00:00Z
tostring · date-timeRequired

End of reporting interval (exclusive), ISO-8601 UTC

Example: 2026-02-23T00:00:00Z
granularitystring · enumRequired

Aggregation granularity for usage data

Example: allPossible values:
Responses
200

Team agent usage

application/json
organizationIdstringRequired
teamIdstringRequired
fromstring · date-timeRequired
tostring · date-timeRequired
get/api/v1/team/agent-usage

Get user agent usage

Get user-level agent usage

get
/api/v1/user/agent-usage

Returns aggregated agent usage for a user, including model breakdown and agent type breakdown.

Authorizations
AuthorizationstringRequired

JWT Bearer token for authentication

Query parameters
organizationIdstringRequired

Organization identifier.

userIdstringRequired

User identifier.

fromstring · date-timeRequired

Start of reporting interval (inclusive), ISO-8601 UTC

Example: 2025-03-23T00:00:00Z
tostring · date-timeRequired

End of reporting interval (exclusive), ISO-8601 UTC

Example: 2026-02-23T00:00:00Z
granularitystring · enumRequired

Aggregation granularity for usage data

Example: allPossible values:
Responses
200

User agent usage

application/json
organizationIdstringRequired
userIdstringRequired
fromstring · date-timeRequired
tostring · date-timeRequired
get/api/v1/user/agent-usage

Last updated

Was this helpful?