OutRival Ai Chat Sessions API
The Ai Chat Sessions API from OutRival — 6 operation(s) for ai chat sessions.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/outrival-ai-chat-sessions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: OutRival Ai Chat Sessions API
description: OutRival API documentation.
version: '1.0'
contact: {}
servers:
- url: https://api.outrival.com
tags:
- name: Ai Chat Sessions
paths:
/rest/v2/ai-chats/{aiChatId}/sessions:
get:
operationId: SessionsController_getByChatId
summary: Get a list of sessions by aiChatId
parameters:
- name: aiChatId
required: true
in: path
schema:
type: string
responses:
'200':
description: ''
tags:
- Ai Chat Sessions
security:
- api_key: []
- bearer: []
/rest/v2/ai-chats/project/{projectId}/sessions:
get:
operationId: SessionsController_getByProjectId
summary: Get a list of sessions by projectId
parameters:
- name: projectId
required: true
in: path
schema:
type: string
- name: aiChatId
required: false
in: query
description: AI Chat ID
schema:
type: string
- name: deployment
required: false
in: query
description: Ai Chat deployment
schema:
type: array
items:
$ref: '#/components/schemas/AiChatChannel'
- name: limit
required: false
in: query
description: Limit of sessions
schema:
default: 20
type: number
- name: startingAfter
required: false
in: query
description: Starting after session id
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CursorBasedPageDto'
- properties:
data:
type: array
items:
$ref: '#/components/schemas/Session'
tags:
- Ai Chat Sessions
security:
- api_key: []
- bearer: []
/rest/v2/ai-chats/sessions/{sessionId}/logs:
get:
operationId: SessionsController_getBySession
summary: Get a list of logs by session
parameters:
- name: sessionId
required: true
in: path
schema:
type: string
- name: types
required: false
in: query
description: Ai Chat Log type
schema:
type: array
items:
$ref: '#/components/schemas/AiChatLogsType'
- name: limit
required: false
in: query
description: Limit of logs
schema:
default: 20
type: number
- name: startingAfter
required: false
in: query
description: Starting after log id
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CursorBasedPageDto'
- properties:
data:
type: array
items:
$ref: '#/components/schemas/Log'
tags:
- Ai Chat Sessions
security:
- api_key: []
- bearer: []
/rest/v2/ai-chats/{AiChatId}/logs:
get:
operationId: SessionsController_getByAiChat
summary: Get a list of all logs by chat
parameters:
- name: AiChatId
required: true
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CursorBasedPageDto'
- properties:
data:
type: array
items:
$ref: '#/components/schemas/Log'
tags:
- Ai Chat Sessions
security:
- api_key: []
- bearer: []
/rest/v2/ai-chats/user/{userId}/logs:
get:
operationId: SessionsController_getByUserId
summary: Get a list of all logs by userId
parameters:
- name: userId
required: true
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CursorBasedPageDto'
- properties:
data:
type: array
items:
$ref: '#/components/schemas/Log'
tags:
- Ai Chat Sessions
security:
- api_key: []
- bearer: []
/rest/v2/ai-chats/workflow/{workflowId}/logs:
get:
operationId: SessionsController_getByWorkflowId
summary: Get a list of all logs by workflowId
parameters:
- name: workflowId
required: true
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CursorBasedPageDto'
- properties:
data:
type: array
items:
$ref: '#/components/schemas/Log'
tags:
- Ai Chat Sessions
security:
- api_key: []
- bearer: []
components:
schemas:
AiChatChannel:
type: string
enum:
- SMS
- VOICE
- TEXT
CursorBasedPageDto:
type: object
properties:
hasMore:
type: boolean
data:
type: array
items:
type: string
required:
- hasMore
- data
Session:
type: object
properties:
id:
type: string
aiChatId:
type: string
startedAt:
format: date-time
type: string
endedAt:
format: date-time
type:
- string
- 'null'
customerMetadata:
type:
- object
- 'null'
callRecording:
type:
- object
- 'null'
deployment:
$ref: '#/components/schemas/AiChatChannel'
required:
- id
- aiChatId
- startedAt
- endedAt
- customerMetadata
- callRecording
- deployment
AiChatLogsType:
type: string
enum:
- SESSION_START
- SESSION_END
- SEND_MESSAGE
- RECEIVE_MESSAGE
- FUNCTION_CALL
- FUNCTION_RESPONSE
- CHANGE_WORKFLOW
- CHANGE_NODE_WORKFLOW
- CALL_RECORDING
- ERROR
Message:
type: object
properties:
id:
type: string
seqId:
type: number
role:
$ref: '#/components/schemas/AiChatMessageRole'
channel:
$ref: '#/components/schemas/AiChatChannel'
content:
type:
- string
- 'null'
toolCallId:
type:
- string
- 'null'
toolCalls:
type:
- object
- 'null'
createdAt:
format: date-time
type: string
required:
- id
- seqId
- role
- channel
- content
- toolCallId
- toolCalls
- createdAt
Log:
type: object
properties:
id:
type: string
type:
$ref: '#/components/schemas/AiChatLogsType'
createdAt:
format: date-time
type: string
sessionId:
type: string
aiChatId:
type: string
workflowId:
type: string
workflowNodeId:
type: string
messageId:
type:
- string
- 'null'
message:
allOf:
- $ref: '#/components/schemas/Message'
aiUserId:
type:
- string
- 'null'
required:
- id
- type
- createdAt
- sessionId
- aiChatId
- workflowId
- workflowNodeId
- messageId
- message
- aiUserId
AiChatMessageRole:
type: string
enum:
- ASSISTANT
- TOOL
- USER
- SYSTEM
securitySchemes:
api_key:
type: apiKey
in: header
name: X-API-Key