Revenium API Reference

https://revenium.readme.io
Admin
Complete REST API reference for the Revenium AI Economic Control platform. Covers metering endpoints...
Tokens:1,274,592
Snippets:6,645
Trust Score:9.9
Update:1 week ago
Show doc for...
Tokens:
Raw
### Response Body for Successful Installation

Source: https://revenium.readme.io/reference/completegithubappinstallation

Example JSON response returned with a 200 status code. Contains the credential status, installation details, and metadata. The 'installations' array lists the GitHub installations with their IDs and logins.

```json
{
  "status": "string",
  "credential": {
    "id": 42,
    "integrationType": "github",
    "credentialName": "acme-github-readonly",
    "validationStatus": "valid",
    "validationError": "string",
    "lastValidatedAt": "2026-09-29T12:00:00Z",
    "metadata": {},
    "authType": "string",
    "installationSettingsUrl": "string",
    "appUnavailableReason": "string"
  },
  "installations": [
    {
      "installationId": 0,
      "login": "string"
    }
  ]
}
```

--------------------------------

### POST /profitstream/v2/api/integration-credentials/github/app/installations

Source: https://revenium.readme.io/reference/completegithubappinstallation

Completes a GitHub App installation using the installation_id, setup_action, state, and code from GitHub's setup redirect, or with setup_action 'link' to connect an existing installation. Returns pending_approval when an organization owner must approve, and choose_installation when a link finds several installations.

```APIDOC
## POST /profitstream/v2/api/integration-credentials/github/app/installations

### Description
Called with the installation_id, setup_action, state and code from GitHub's setup redirect, or with setup_action 'link', the state and the code from GitHub's sign-in to connect an installation that already exists. The state must be one this caller started, and the code must belong to an owner of the installation's organization, so a forged installation_id cannot connect another organization. Returns pending_approval when an organization owner still has to approve the request, and choose_installation when a link finds several installations, to link again with the one picked.

### Method
POST

### Endpoint
https://api.revenium.ai/profitstream/v2/api/integration-credentials/github/app/installations

### Parameters
#### Query Parameters
- **teamId** (string) - Optional - Team to read or write, as the team's hashid (the same id as /v2/api/teams/{id}). The caller must belong to it or be able to read it: 403 otherwise, 404 when no such team exists. An API key may only name its own organization. Omit it for the API key's organization, or for a signed-in user the first organization they belong to.

#### Request Body
- **installationId** (int64 | null) - Required - installation_id from GitHub's setup redirect; null when setupAction is 'request', and for 'link' unless the person picked one of several
- **setupAction** (string) - Required - setup_action from GitHub's setup redirect: install, update or request; link after GitHub's sign-in
- **state** (string) - Required - The state from GitHub's setup redirect, issued by the install-sessions endpoint
- **code** (string | null) - Required - code from GitHub's setup redirect, proving the GitHub user can manage the installation; required unless setupAction is 'request'

### Headers
- **accept** (string) - Optional - Defaults to application/json. Allowed values: `*/*`, `application/json`

### Responses
- **200** - Success response. Returns pending_approval when an organization owner still has to approve the request, and choose_installation when a link finds several installations.

```

--------------------------------

### 201 response body for GitHub App installation session

Source: https://revenium.readme.io/reference/creategithubappinstallsession

Example response body for a successful installation session creation. The installUrl is GitHub's install page, linkUrl is GitHub's sign-in for existing installations, and expiresAt indicates when the state stops being accepted.

```json
{
  "installUrl": "string",
  "linkUrl": "string",
  "expiresAt": "2026-10-14T12:25:47.474Z"
}
```

--------------------------------

### 200 OK Response for Get Available Organizations

Source: https://revenium.readme.io/reference/get_available_organizations

Example JSON response returned on success. Contains organization metadata, embedded items, links, and pagination details.

```json
{
  "id": "string",
  "resourceType": "string",
  "label": "string",
  "created": "2026-10-14T12:30:45.720Z",
  "updated": "2026-10-14T12:30:45.720Z",
  "period": {
    "start": "2026-10-14T12:30:45.720Z",
    "end": "2026-10-14T12:30:45.720Z"
  },
  "_embedded": {
    "items": [
      {
        "id": "string",
        "numericId": "string",
        "name": "string"
      }
    ]
  },
  "_links": {
    "additionalProp": {
      "href": "string"
    }
  },
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "number": 0
  }
}
```

--------------------------------

### GET /profitstream/v2/api/reports/chart-definitions

Source: https://revenium.readme.io/reference/list_chart_definitions

Documentation for the GET chart definitions endpoint, including parameters, request example, response structure, and error codes.

```APIDOC
## GET /profitstream/v2/api/reports/chart-definitions

### Description
Retrieves a paginated list of chart definitions. This endpoint returns chart definitions with their configuration, team information, and links.

### Method
GET

### Endpoint
/profitstream/v2/api/reports/chart-definitions

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number for pagination.
- **size** (integer) - Optional - Number of items per page.
- **sort** (string) - Optional - Sort criteria, e.g., `updated,DESC` and `id,DESC`.

### Request Example
```
curl --request GET \
     --url 'https://api.revenium.ai/profitstream/v2/api/reports/chart-definitions?page=0&size=20&sort=updated%2CDESC&sort=id%2CDESC' \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
- **_embedded.chartDefinitionResourceList** (array) - List of chart definition resources.
  - **id** (string) - Unique identifier of the chart definition.
  - **resourceType** (string) - Type of resource, e.g., `chart_definition`.
  - **label** (string) - Human-readable label.
  - **created** (string) - Creation timestamp.
  - **updated** (string) - Last update timestamp.
  - **name** (string) - Name of the chart definition.
  - **description** (string) - Description of the chart definition.
  - **configuration** (object) - Configuration details.
    - **mode** (string) - Mode, e.g., `aggregate`.
    - **chartType** (string) - Type of chart, e.g., `column`.
    - **dateRange** (string) - Date range, e.g., `7d`.
    - **grain** (string) - Grain, e.g., `auto`.
    - **primaryMetric** (object) - Primary metric configuration.
      - **baseMetric** (string) - Base metric, e.g., `requestCount`.
      - **calculationType** (string) - Calculation type, e.g., `average`.
      - **entityType** (string) - Entity type, e.g., `agent`.
    - **primaryGroupBy** (string) - Primary grouping, e.g., `none`.
    - **filters** (array) - List of filters.
  - **team** (object) - Team information.
    - **id** (string) - Team identifier.
    - **resourceType** (string) - Resource type, e.g., `organization`.
    - **label** (string) - Team label.
  - **_links.self.href** (string) - Self link to the chart definition.
- **page** (object) - Pagination details.
  - **size** (integer) - Page size.
  - **totalElements** (integer) - Total number of elements.
  - **totalPages** (integer) - Total number of pages.

#### Response Example
```
{
  "_embedded": {
    "chartDefinitionResourceList": [
      {
        "id": "d5jKBD",
        "resourceType": "chart_definition",
        "label": "Average transaction counts by customer",
        "created": "2025-10-17T18:37:42.821Z",
        "updated": "2025-10-23T19:04:15.811Z",
        "name": "Average transaction counts by customer",
        "description": "Tracks average request counts per agent",
        "configuration": {
          "mode": "aggregate",
          "chartType": "column",
          "dateRange": "7d",
          "grain": "auto",
          "primaryMetric": {
            "baseMetric": "requestCount",
            "calculationType": "average",
            "entityType": "agent"
          },
          "primaryGroupBy": "none",
          "filters": []
        },
        "team": {
          "id": "XPozX1E",
          "resourceType": "organization",
          "label": "Example Team Name"
        },
        "_links": {
          "self": {
            "href": "/profitstream/v2/api/reports/chart-definitions/d5jKBD"
          }
        }
      }
    ]
  },
  "page": {
    "size": 20,
    "totalElements": 1,
    "totalPages": 1
  }
}
```

### Error Handling
- **400** - Invalid request
- **401** - Unauthorized - Authentication required
- **403** - Forbidden - Insufficient permissions
- **404** - Not Found
- **409** - Conflict
- **422** - Unprocessable entity - Validation failed
- **429** - Too Many Requests
- **500** - Internal server error
- **504** - Gateway Timeout
```

--------------------------------

### POST /integration-credentials/github/installations/complete

Source: https://revenium.readme.io/llms.txt

Called with the installation_id, setup_action, state and code from GitHub's setup redirect, or with setup_action 'link', the state and the code from GitHub's sign-in to connect an installation that…

```APIDOC
## POST /integration-credentials/github/installations/complete

### Description
Called with the installation_id, setup_action, state and code from GitHub's setup redirect, or with setup_action 'link', the state and the code from GitHub's sign-in to connect an installation that…

### Method
POST

### Endpoint
/integration-credentials/github/installations/complete

### Request Body
- **installation_id** (string) - Required - The GitHub installation ID.
- **setup_action** (string) - Required - The setup action from GitHub.
- **state** (string) - Required - The state parameter from GitHub.
- **code** (string) - Required - The code from GitHub.

### Response
#### Success Response (200)
Indicates the installation was completed.

```

--------------------------------

### GET /investigators

Source: https://revenium.readme.io/llms.txt

List the investigators (cost checks) that analyze your usage when an insights run is started. Use the id values to choose which investigators to skip in excludeInvestigatorIds when you start a run.

```APIDOC
## GET /investigators

### Description
List the investigators (cost checks) that analyze your usage when an insights run is started. Use the `id` values to choose which investigators to skip in `excludeInvestigatorIds` when you start a run.

### Method
GET

### Endpoint
/investigators

### Response
#### Success Response (200)
- **id** (string) - The investigator ID.
- **name** (string) - The investigator name.
- **description** (string) - The investigator description.

#### Response Example
[
  {
    "id": "string",
    "name": "string",
    "description": "string"
  }
]
```

--------------------------------

### POST /integration-credentials/github/installations/start

Source: https://revenium.readme.io/llms.txt

Returns GitHub's install page for the Revenium GitHub App with a single-use state bound to the caller and the caller's organization. The browser is sent there; GitHub redirects back with the state.

```APIDOC
## POST /integration-credentials/github/installations/start

### Description
Returns GitHub's install page for the Revenium GitHub App with a single-use state bound to the caller and the caller's organization. The browser is sent there; GitHub redirects back with the state.

### Method
POST

### Endpoint
/integration-credentials/github/installations/start

### Response
#### Success Response (200)
Returns the GitHub install page URL.

```

--------------------------------

### 200 Response Example for cost-metric-by-provider-over-time

Source: https://revenium.readme.io/reference/get_cost_metric_by_provider_over_time

Example JSON response returned on success. Contains start and end timestamps, a list of groups with provider metrics, and nested model AI metrics with links.

```json
{
  "startTimestamp": 1704067200000,
  "endTimestamp": 1704153600000,
  "groups": [
    {
      "groupName": "open_ai",
      "metrics": [
        {
          "startTimestamp": 1704067200000,
          "endTimestamp": 1704153600000,
          "provider": "open_ai",
          "metricResult": 1234.56,
          "metricType": "TOTAL_COST_BY_PROVIDER",
          "aggregatedModelAIMetrics": [
            {
              "startTimestamp": 0,
              "endTimestamp": 0,
              "model": "claude-2-70b",
              "metricResult": 0,
              "timeResult": 0,
              "metricType": "string",
              "_links": {
                "additionalProp": {
                  "href": "string",
                  "hreflang": "string",
                  "title": "string",
                  "type": "string",
                  "deprecation": "string",
                  "profile": "string",
                  "name": "string",
                  "templated": true
                }
              }
            }
          ],
          "_links": {
            "additionalProp": {
              "href": "string",
              "hreflang": "string",
              "title": "string",
              "type": "string",
              "deprecation": "string",
              "profile": "string",
              "name": "string",
              "templated": true
            }
          }
        }
      ]
    }
  ]
}
```

--------------------------------

### 200 response for a simple product with basic subscription plan

Source: https://revenium.readme.io/reference/get_product

Example JSON response returned when the product is found. It includes product metadata, team and owner information, and a subscription plan with a base tier. The 'published' field is false.

```json
{
  "id": "3BygBVb",
  "resourceType": "product",
  "label": "basic-api-product",
  "created": "2025-10-17T20:13:39.686Z",
  "updated": "2025-10-17T20:13:39.686Z",
  "team": {
    "id": "XPozX1E",
    "resourceType": "organization",
    "label": "Example Team Name"
  },
  "owner": {
    "id": "br7rP0K",
    "resourceType": "user",
    "label": "user@example.com"
  },
  "name": "basic-api-product",
  "version": "1.0.0",
  "description": "A basic API product for developers",
  "plan": {
    "type": "SUBSCRIPTION",
    "name": "Basic Monthly Plan",
    "currency": "USD",
    "period": "MONTH",
    "periodCount": 1,
    "charge": 0,
    "graduated": false,
    "prePayAllFlatRates": false,
    "tiers": [
      {
        "id": "1372633702",
        "name": "Base Tier",
        "startingFrom": 0,
        "unitAmount": 29.99
      }
    ],
    "elements": [],
    "setupFees": [],
    "ratingAggregations": []
  },
  "published": false
}
```

--------------------------------

### POST /profitstream/v2/api/integration-credentials/github/app/install-sessions

Source: https://revenium.readme.io/reference/creategithubappinstallsession

Creates a GitHub App installation session. Returns GitHub's install page for the Revenium GitHub App with a single-use state bound to the caller and the caller's organization. The browser is sent there; GitHub redirects back with the state.

```APIDOC
## POST /profitstream/v2/api/integration-credentials/github/app/install-sessions

### Description
Returns GitHub's install page for the Revenium GitHub App with a single-use state bound to the caller and the caller's organization. The browser is sent there; GitHub redirects back with the state.

### Method
POST

### Endpoint
https://api.revenium.ai/profitstream/v2/api/integration-credentials/github/app/install-sessions

### Parameters
#### Query Parameters
- **teamId** (string) - Optional - Team to read or write, as the team's hashid (the same id as /v2/api/teams/{id}). The caller must belong to it or be able to read it: 403 otherwise, 404 when no such team exists. An API key may only name its own organization. Omit it for the API key's organization, or for a signed-in user the first organization they belong to.

#### Headers
- **accept** (string) - Optional - Defaults to application/json. Allowed: `*/*`, `application/json`.

### Request Example
```
curl --request POST \
     --url https://api.revenium.ai/profitstream/v2/api/integration-credentials/github/app/install-sessions \
     --header 'accept: application/json'
```

### Response
#### Success Response (201)
- **installUrl** (string) - GitHub's install page for the Revenium GitHub App, carrying the single-use state
- **linkUrl** (string) - GitHub's sign-in for the app, carrying the same state, to connect an installation that already exists
- **expiresAt** (date-time) - When the state stops being accepted

#### Response Example
```
{
  "installUrl": "string",
  "linkUrl": "string",
  "expiresAt": "2026-10-14T12:25:47.474Z"
}
```

#### Error Responses
- **400** - The GitHub App connection is not configured on this environment
- **401** - Unauthorized
- **403** - Forbidden, including read-only users
- **404** - No organization for the caller
- **409** - Conflicting state for the requested operation
- **422** - Request understood but could not be processed
- **429** - The caller started 10 installations in this team in the last 15 minutes. details.reason is INSTALL_SESSION_LIMIT; retryAfterSeconds says when to try again.
- **500** - Internal server error
- **504** - Gateway Timeout

```

--------------------------------

### 200 Response Body for Get AI Trace Detail

Source: https://revenium.readme.io/reference/get_ai_trace_detail

Example 200 response body for the Get AI Trace Detail endpoint. Contains trace metadata, token usage, cost, and status fields.

```json
{
  "id": "string",
  "resourceType": "ai.trace.detail",
  "label": "string",
  "created": "2024-09-01T00:00:00Z",
  "updated": "2024-09-01T00:00:00Z",
  "traceTypes": [
    "document_analysis",
    "video_creation"
  ],
  "operationTypes": [
    "CHAT",
    "IMAGE"
  ],
  "traceName": "Customer Onboarding - Acme Corp",
  "agent": "Bishop",
  "squadId": "research-squad",
  "startTime": "2025-09-01T00:00:00Z",
  "endTime": "2025-09-01T00:01:30Z",
  "traceDuration": 90000,
  "totalDurationSum": 150000,
  "transactionCount": 15,
  "errorCount": 2,
  "models": [
    "gpt-4",
    "claude-3"
  ],
  "providers": [
    "OpenAI",
    "Anthropic"
  ],
  "inputTokens": 5000,
  "outputTokens": 3000,
  "totalTokens": 8000,
  "totalCost": 0.0024,
  "environment": "production",
  "status": "SUCCESS",
  "taskTypes": [
    "completion",
    "embedding"
  ],
  "timeToFirstToken": 250,
  "subscriberEmail": "user@example.com"
}
```

--------------------------------

### cURL Request to Get Cost by User Aggregated

Source: https://revenium.readme.io/reference/get_cost_by_user_aggregated

The request URL includes query parameters 'page', 'size', and 'costSources'. The 'costSources' parameter is set to 'coding_assistant' in this example. The example uses the 'Bearer' credential type.

```Shell
curl --request GET \
     --url 'https://app.revenium.ai/api/v2/analytics/cost-by-user-aggregated?page=0&size=20&costSources=coding_assistant' \
     --header 'accept: application/json'
```

--------------------------------

### POST /profitstream/v2/api/integration-credentials/github/app/installations

Source: https://revenium.readme.io/reference/completegithubappinstallation

Completes a GitHub App installation by creating integration credentials. The request body is empty, and the response includes the credential and installation information.

```APIDOC
## POST /profitstream/v2/api/integration-credentials/github/app/installations

### Description
Completes a GitHub App installation by creating integration credentials. The request body is empty, and the response includes the credential and installation information.

### Method
POST

### Endpoint
https://api.revenium.ai/profitstream/v2/api/integration-credentials/github/app/installations

### Parameters
#### Request Body
- (empty object) - Required - The request body must be an empty JSON object `{}`.

### Request Example
```
curl --request POST \
     --url https://api.revenium.ai/profitstream/v2/api/integration-credentials/github/app/installations \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{}'
```

### Response
#### Success Response (200)
- **status** (string) - Status of the operation.
- **credential** (object) - The created credential details.
  - **id** (integer) - Credential ID.
  - **integrationType** (string) - Type of integration, e.g., "github".
  - **credentialName** (string) - Name of the credential.
  - **validationStatus** (string) - Validation status, e.g., "valid".
  - **validationError** (string) - Validation error message, if any.
  - **lastValidatedAt** (string) - Timestamp of last validation.
  - **metadata** (object) - Additional metadata.
  - **authType** (string) - Authentication type.
  - **installationSettingsUrl** (string) - URL for installation settings.
  - **appUnavailableReason** (string) - Reason if app is unavailable.
- **installations** (array) - List of installations.
  - **installationId** (integer) - Installation ID.
  - **login** (string) - Login associated with the installation.

#### Response Example
```
{
  "status": "string",
  "credential": {
    "id": 42,
    "integrationType": "github",
    "credentialName": "acme-github-readonly",
    "validationStatus": "valid",
    "validationError": "string",
    "lastValidatedAt": "2026-09-29T12:00:00Z",
    "metadata": {},
    "authType": "string",
    "installationSettingsUrl": "string",
    "appUnavailableReason": "string"
  },
  "installations": [
    {
      "installationId": 0,
      "login": "string"
    }
  ]
}
```

### Error Responses
- **429** - Too Many Requests
- **500** - Internal server error
- **504** - Gateway Timeout

### Headers
- **X-RateLimit-Limit** - Rate limit quota.
- **X-RateLimit-Remaining** - Remaining requests in the current rate limit window.
- **X-RateLimit-Reset** - Time when the rate limit resets.
- **X-RateLimit-Bucket** - Rate limit bucket identifier.
```

--------------------------------

### 200 Response Body for Get Current User

Source: https://revenium.readme.io/reference/get_current_user

Example 200 response body for the Get Current User endpoint. Contains user profile fields such as id, email, roles, tenant, teams, and self link.

```json
{
  "id": "br7rP0K",
  "resourceType": "user",
  "label": "user@example.com",
  "created": "2025-10-13T19:09:08.410Z",
  "updated": "2025-10-16T01:45:46.586Z",
  "email": "user@example.com",
  "firstName": "Ash",
  "lastName": "Williams",
  "roles": [
    "ROLE_TENANT_ADMIN"
  ],
  "tenant": {
    "id": "Ag8nd4k",
    "resourceType": "tenant",
    "label": "Example Account",
    "usageBillingEnabled": false
  },
  "teams": [
    {
      "id": "XPozX1E",
      "resourceType": "team",
      "label": "Example Team Name"
    }
  ],
  "_links": {
    "self": {
      "href": "/profitstream/v2/api/users/br7rP0K"
    }
  }
}
```

--------------------------------

### 201 Response Body for Create Tool

Source: https://revenium.readme.io/reference/create_tool

Example response body returned on successful tool creation. Contains the tool resource with id, toolId, name, description, toolType, toolProvider, configSource, enabled, and team details.

```json
{
  "id": "a91XJp",
  "resourceType": "tool",
  "label": "GitHub MCP Server",
  "created": "2024-09-01T00:00:00Z",
  "updated": "2024-09-01T00:00:00Z",
  "team": {
    "id": "JMwX9g4",
    "resourceType": "string",
    "label": "string",
    "created": "2024-09-01T00:00:00Z",
    "updated": "2024-09-01T00:00:00Z",
    "_links": {
      "additionalProp": {
        "href": "string",
        "hreflang": "string",
        "title": "string",
        "type": "string",
        "deprecation": "string",
        "profile": "string",
        "name": "string",
        "templated": true
      }
    }
  },
  "toolId": "mcp-github",
  "name": "GitHub MCP Server",
  "description": "MCP server for GitHub operations",
  "toolType": "MCP_SERVER",
  "toolProvider": "anthropic",
  "configSource": "DATABASE",
  "enabled": true,
  "plan": {
    "id": "JMwX9g4",
    "resourceType": "string",
    "label": "string"
  }
}
```

--------------------------------

### Update a Product

Source: https://revenium.readme.io/llms.txt

Replaces a product's settings with what you send. Send the whole product, starting from what GET returns and changing what you need. GET returns team, owner and sources as nested objects, but PUT...

```APIDOC
## PUT /reference/update_product

### Description
Replaces a product's settings with what you send. Send the whole product, starting from what GET returns and changing what you need. GET returns team, owner and sources as nested objects, but PUT...

### Method
PUT

### Endpoint
/reference/update_product
```

--------------------------------

### 201 response for basic team creation

Source: https://revenium.readme.io/reference/create_team

Example JSON response returned when a team is successfully created. Contains team details such as id, label, tenant, and various configuration flags.

```json
{
  "id": "br7rP0K",
  "resourceType": "team",
  "label": "New Team",
  "created": "2025-10-22T19:10:00.000Z",
  "updated": "2025-10-22T19:10:00.000Z",
  "name": "New Team",
  "currency": "USD",
  "metadata": "",
  "domainAliases": [],
  "types": [
    "MANAGING"
  ],
  "tenant": {
    "id": "Ag8nd4k",
    "resourceType": "tenant",
    "label": "Example Account",
    "created": "2025-10-13T19:09:08.234Z",
    "updated": "2025-10-16T19:03:11.216Z"
  },
  "sourceAutoDiscoveryEnabled": false,
  "elementDefinitionAutoDiscoveryEnabled": false,
  "aiDataIngested": false,
  "useV2InvoiceDataLoading": false
}
```

--------------------------------

### 201 response body for create product

Source: https://revenium.readme.io/reference/create_product

Example JSON response returned when a product is successfully created. Contains the product ID, resource type, label, timestamps, team and owner objects with links.

```json
{
  "id": "string",
  "resourceType": "product",
  "label": "My Awesome Product",
  "created": "2024-09-01T00:00:00Z",
  "updated": "2024-09-01T00:00:00Z",
  "team": {
    "id": "JMwX9g4",
    "resourceType": "string",
    "label": "string",
    "created": "2024-09-01T00:00:00Z",
    "updated": "2024-09-01T00:00:00Z",
    "_links": {
      "additionalProp": {
        "href": "string",
        "hreflang": "string",
        "title": "string",
        "type": "string",
        "deprecation": "string",
        "profile": "string",
        "name": "string",
        "templated": true
      }
    }
  },
  "owner": {
    "id": "JMwX9g4",
    "resourceType": "string",
    "label": "string",
    "created": "2024-09-01T00:00:00Z",
    "updated": "2024-09-01T00:00:00Z",
    "_links": {
      "additionalProp": {
        "href": "string",
        "hreflang": "string",
        "title": "string",
        "type": "string",
        "deprecation": "string",
        "profile": "string",
        "name": "string",
        "templated": true
      }
    }
  }
}
```

--------------------------------

### 200 Response Body for Get Organization

Source: https://revenium.readme.io/reference/get_organization

Example JSON response returned by the Get Organization endpoint. Contains organization fields such as id, label, name, address, contact info, metadata, domain aliases, types, and tenant details.

```json
{
  "id": "string",
  "resourceType": "organization",
  "label": "Weyland-Yutani Corporation",
  "created": "2024-09-01T00:00:00Z",
  "updated": "2024-09-01T00:00:00Z",
  "name": "Weyland-Yutani Corporation",
  "externalId": "WY-1234",
  "logo": "https://www.example.com/logo.png",
  "address1": "Main St.",
  "address2": "Suite 100",
  "city": "Brooklyn",
  "state": "NY",
  "country": "USA",
  "postalCode": "11201",
  "billingPhoneNumber": "555-555-5555",
  "phoneNumber": "555-555-5555",
  "emailAddress": "contact@weyland-yutani.com",
  "remittanceInstructions": "Please remit payment to the address above",
  "url": "https://www.weyland-yutani.com",
  "currency": "USD",
  "metadata": "{'key1': 'value1', 'key2': 'value2'}",
  "domainAliases": [
    "weyland-yutani.com",
    "wy-corp.com"
  ],
  "types": [
    "CONSUMER"
  ],
  "tenant": {
    "id": "JMwX9g4",
    "resourceType": "string",
    "label": "string",
    "created": "2024-09-01T00:00:00Z",
    "updated": "2024-09-01T00:00:00Z",
    "_links": {
      "additionalProp": {
        "href": "string",
        "hreflang": "string",
        "title": "string",
        "type": "string",
        "deprecation": "string",
        "profile": "string"
      }
    }
  }
}
```

--------------------------------

### 201 Response for Basic Organization Creation

Source: https://revenium.readme.io/reference/create_organization

Example response body returned when an organization is successfully created. It includes the organization ID, resource type, label, timestamps, name, types, tenant details, and self link.

```json
{
  "id": "xyz123",
  "resourceType": "organization",
  "label": "Acme Corporation",
  "created": "2025-10-17T22:00:00Z",
  "updated": "2025-10-17T22:00:00Z",
  "name": "Acme Corporation",
  "types": [
    "CONSUMER"
  ],
  "tenant": {
    "id": "Ag8nd4k",
    "resourceType": "tenant",
    "label": "Default Account"
  },
  "_links": {
    "self": {
      "href": "/profitstream/v2/api/organizations/xyz123"
    }
  }
}
```

--------------------------------

### Example JSON Response for Total Cost by Model

Source: https://revenium.readme.io/reference/get_total_cost_by_model

Example response body for a successful 200 request. It contains a start and end timestamp, and a groups array with one group per model, each including a metricResult and metricType 'COST_METRIC_BY_MODEL'.

```json
{
  "startTimestamp": "2024-11-01T00:00:00Z",
  "endTimestamp": "2025-10-22T21:31:43.364556304Z",
  "groups": [
    {
      "groupName": "claude-3-opus-20240229",
      "metrics": [
        {
          "startTimestamp": "2024-11-01T00:00:00Z",
          "endTimestamp": "2025-10-22T21:31:43.364556304Z",
          "model": "claude-3-opus-20240229",
          "metricResult": 0.087825,
          "metricType": "COST_METRIC_BY_MODEL"
        }
      ]
    },
    {
      "groupName": "gpt-4",
      "metrics": [
        {
          "startTimestamp": "2024-11-01T00:00:00Z",
          "endTimestamp": "2025-10-22T21:31:43.364556304Z",
          "model": "gpt-4",
          "metricResult": 0.0345,
          "metricType": "COST_METRIC_BY_MODEL"
        }
      ]
    }
  ]
}
```

--------------------------------

### 201 Response for Basic Subscription Creation

Source: https://revenium.readme.io/reference/create_subscription

Example JSON response returned when a subscription is successfully created. Contains subscription details such as id, subscriberEmail, product, and credentials array.

```json
{
  "id": "abc123",
  "resourceType": "subscription",
  "label": "client@example.com",
  "subscriberEmail": "client@example.com",
  "clientEmailAddress": "client@example.com",
  "created": "2025-10-17T21:00:00Z",
  "updated": "2025-10-17T21:00:00Z",
  "name": "basic-subscription",
  "owner": {
    "id": "br7rP0K",
    "resourceType": "user",
    "label": "user@example.com"
  },
  "client": {
    "id": "xyz789",
    "resourceType": "subscriber",
    "label": "client@example.com"
  },
  "team": {
    "id": "XPozX1E",
    "resourceType": "team",
    "label": "user@example.com"
  },
  "product": {
    "id": "3BygBVb",
    "resourceType": "product",
    "label": "basic-api-product"
  },
  "credentials": [],
  "isActive": true,
  "isValid": true,
  "_links": {
    "self": {
      "href": "/profitstream/v2/api/subscriptions/abc123"
    }
  }
}
```

--------------------------------

### 200 Response Example for Get Job Transactions

Source: https://revenium.readme.io/reference/get_job_transactions

Example response body showing the top-level shape with transactions array and totalCount. Each transaction includes transactionId, timestamp, agent, model, provider, duration, cost, inputTokens, outputTokens, totalTokens, and status.

```json
{
  "transactions": [
    {
      "transactionId": "txn-abc123",
      "timestamp": "2026-04-26T04:16:31.874Z",
      "agent": "loan-document-classifier",
      "model": "claude-3-5-haiku-latest",
      "provider": "anthropic",
      "duration": 5207,
      "cost": 0.010468,
      "inputTokens": 7693,
      "outputTokens": 555,
      "totalTokens": 8248,
      "status": "success"
    }
  ],
  "totalCount": 1
}
```
Tokens:
Raw