Altimate AI AI_STUDIO API
The AI_STUDIO API from Altimate AI — 22 operation(s) for ai_studio.
The AI_STUDIO API from Altimate AI — 22 operation(s) for ai_studio.
openapi: 3.1.0
info:
title: Fast ACCOUNT_COSTS AI_STUDIO API
version: 0.1.0
tags:
- name: AI_STUDIO
paths:
/studio/share/shared/{share_id}:
get:
tags:
- AI_STUDIO
summary: View Shared Session
description: 'View a shared playground session.
This is the public endpoint for viewing shared content.
- ''anyone'' links: No authentication required
- ''specific_people'' links: User must be authenticated and in the allowed list'
operationId: view_shared_session_studio_share_shared__share_id__get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: share_id
in: path
required: true
schema:
type: string
format: uuid
title: Share Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SharedSessionResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/studio/share:
post:
tags:
- AI_STUDIO
summary: Create Share
description: 'Create a new share link for a playground session.
- **session_id**: The session to share
- **access_type**: ''anyone'' (public) or ''specific_people'' (restricted)
- **expires_in_days**: Optional expiration (1-365 days)
- **user_ids**: Required for ''specific_people'' access type
- **title**: Optional title for the share link'
operationId: create_share_studio_share_post
security:
- HTTPBearer: []
- HTTPBearer: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ShareLinkCreateRequest'
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ShareLinkResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- AI_STUDIO
summary: List Shares
description: 'List share links.
- If session_id is provided, returns share links for that session
- Otherwise, returns all share links created by the current user'
operationId: list_shares_studio_share_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: session_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ShareLinkListResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/studio/share/session/{session_id}:
get:
tags:
- AI_STUDIO
summary: List Shares For Session
description: List share links for a specific session.
operationId: list_shares_for_session_studio_share_session__session_id__get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
title: Session Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ShareLinkListResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/studio/share/{share_id}:
get:
tags:
- AI_STUDIO
summary: Get Share
description: Get details of a specific share link.
operationId: get_share_studio_share__share_id__get
deprecated: true
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: share_id
in: path
required: true
schema:
type: string
format: uuid
title: Share Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ShareLinkResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- AI_STUDIO
summary: Delete Share
description: Delete a share link.
operationId: delete_share_studio_share__share_id__delete
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: share_id
in: path
required: true
schema:
type: string
format: uuid
title: Share Id
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/studio/share/slack:
post:
tags:
- AI_STUDIO
summary: Share To Slack
description: Share a Studio session to Slack via incoming webhook.
operationId: share_to_slack_studio_share_slack_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ShareToSlackRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ShareToSlackResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
- HTTPBearer: []
/studio/schedules:
post:
tags:
- AI_STUDIO
summary: Create Schedule Endpoint
description: 'Create a new scheduled report.
- **name**: Name for this schedule
- **session_id**: Session to report on
- **content_scope**: ''last_answer'' or ''full_chat''
- **frequency**: ''daily'', ''weekly'', ''monthly'', or ''custom''
- **hour**: Hour to run (0-23 UTC)
- **emails**: Recipients'
operationId: create_schedule_endpoint_studio_schedules_post
security:
- HTTPBearer: []
- HTTPBearer: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/app__schemas__ai_playground__schedules__ScheduleCreateRequest'
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/app__schemas__ai_playground__schedules__ScheduleResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- AI_STUDIO
summary: List Schedules
description: 'List schedules.
- If session_id is provided, returns schedules for that session
- Otherwise, returns all schedules created by the current user'
operationId: list_schedules_studio_schedules_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: session_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Session Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/app__schemas__ai_playground__schedules__ScheduleListResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/studio/schedules/{schedule_id}:
get:
tags:
- AI_STUDIO
summary: Get Schedule Endpoint
description: Get details of a specific schedule.
operationId: get_schedule_endpoint_studio_schedules__schedule_id__get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: schedule_id
in: path
required: true
schema:
type: string
format: uuid
title: Schedule Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/app__schemas__ai_playground__schedules__ScheduleResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
tags:
- AI_STUDIO
summary: Update Schedule Endpoint
description: Update a schedule.
operationId: update_schedule_endpoint_studio_schedules__schedule_id__put
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: schedule_id
in: path
required: true
schema:
type: string
format: uuid
title: Schedule Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/app__schemas__ai_playground__schedules__ScheduleUpdateRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/app__schemas__ai_playground__schedules__ScheduleResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- AI_STUDIO
summary: Delete Schedule Endpoint
description: Delete a schedule.
operationId: delete_schedule_endpoint_studio_schedules__schedule_id__delete
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: schedule_id
in: path
required: true
schema:
type: string
format: uuid
title: Schedule Id
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/studio/schedules/{schedule_id}/toggle:
post:
tags:
- AI_STUDIO
summary: Toggle Schedule
description: Enable or disable a schedule.
operationId: toggle_schedule_studio_schedules__schedule_id__toggle_post
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: schedule_id
in: path
required: true
schema:
type: string
format: uuid
title: Schedule Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/app__schemas__ai_playground__schedules__ScheduleResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/studio/schedules/{schedule_id}/refresh-snapshot:
post:
tags:
- AI_STUDIO
summary: Refresh Snapshot
description: Refresh the snapshot content for a schedule.
operationId: refresh_snapshot_studio_schedules__schedule_id__refresh_snapshot_post
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: schedule_id
in: path
required: true
schema:
type: string
format: uuid
title: Schedule Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/app__schemas__ai_playground__schedules__ScheduleResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/studio/schedules/{schedule_id}/send-now:
post:
tags:
- AI_STUDIO
summary: Send Now Endpoint
description: 'Trigger a scheduled report to be sent immediately with fresh execution.
Returns 202 Accepted immediately; the report is generated and emailed
in the background. Check the schedule''s runs endpoint for status.'
operationId: send_now_endpoint_studio_schedules__schedule_id__send_now_post
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: schedule_id
in: path
required: true
schema:
type: string
format: uuid
title: Schedule Id
responses:
'202':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/studio/schedules/{schedule_id}/runs:
get:
tags:
- AI_STUDIO
summary: Get Schedule Runs Endpoint
description: Get recent runs for a schedule.
operationId: get_schedule_runs_endpoint_studio_schedules__schedule_id__runs_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: schedule_id
in: path
required: true
schema:
type: string
format: uuid
title: Schedule Id
- name: limit
in: query
required: false
schema:
type: integer
maximum: 100
default: 10
title: Limit
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduleRunsListResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/studio/sessions:
get:
tags:
- AI_STUDIO
summary: Get Sessions
description: Get all AI playground sessions for a user with pagination support for infinite scroll
operationId: get_sessions_studio_sessions_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: search_text
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Search Text
- name: page
in: query
required: false
schema:
type: integer
minimum: 1
description: Page number starting from 1
default: 1
title: Page
description: Page number starting from 1
- name: page_size
in: query
required: false
schema:
type: integer
maximum: 100
minimum: 1
description: Number of items per page
default: 20
title: Page Size
description: Number of items per page
- name: status
in: query
required: false
schema:
$ref: '#/components/schemas/SessionLifecycleListFilter'
description: active (default), archived, or all (active+archived)
default: active
description: active (default), archived, or all (active+archived)
- name: navigationSource
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Navigationsource
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AllSessionResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/studio/sessions/{session_id}:
patch:
tags:
- AI_STUDIO
summary: Update Session Status
description: 'Archive (``archived``), restore (``active``), or soft-delete
(``deleted``) a single session owned by the authenticated user.
Soft-deleted sessions remain in the database. It will be backed
into s3 later.'
operationId: update_session_status_studio_sessions__session_id__patch
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
title: Session Id
- name: navigationSource
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Navigationsource
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SessionStatusUpdateRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SessionStatusUpdateResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- AI_STUDIO
summary: Get Session By Id
description: Get a specific AI playground session by ID with its turns
operationId: get_session_by_id_studio_sessions__session_id__get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
title: Session Id
- name: navigationSource
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Navigationsource
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SessionResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/studio/ask:
post:
tags:
- AI_STUDIO
summary: Ask Session
description: 'Ask a question in an AI playground session and get streaming response.
The actual pipeline (security scan, output guard, service invocation,
streaming) lives in ``app.service.ai_playground.ask_pipeline.run_ask_pipeline``
so it can be reused by the playground scheduler worker without an HTTP
callback. This endpoint is now a thin transport wrapper.'
operationId: ask_session_studio_ask_post
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: navigationSource
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Navigationsource
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SessionAskRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/studio/prompt/enhance:
post:
tags:
- AI_STUDIO
summary: Enhance Prompt
description: Enhance a user prompt - Temporary proxy to actual prompt enhancer
operationId: enhance_prompt_studio_prompt_enhance_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PromptEnhancementRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PromptEnhancementResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
- HTTPBearer: []
/studio/session_to_pdf:
post:
tags:
- AI_STUDIO
summary: Session To Pdf
description: 'Generate a PDF report from the full conversation thread of a session.
Includes all user questions and assistant answers.'
operationId: session_to_pdf_studio_session_to_pdf_post
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: navigationSource
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Navigationsource
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SessionToPdfRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/studio/session_to_email_mailing_list:
post:
tags:
- AI_STUDIO
summary: Session To Email Mailing List
description: 'Generate a PDF from the full conversation thread and send via email.
Recipients are resolved from ``recipient_type``:
- ``specific_emails``: the explicit, regex-validated ``emails`` list (To)
- ``all_altimate_users``: every active tenant user (BCC fan-out)
- ``team``: active members of the selected teams (BCC fan-out)'
operationId: session_to_email_mailing_list_studio_session_to_email_mailing_list_post
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: navigationSource
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Navigationsource
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SessionToEmailRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/studio/cancel:
post:
tags:
- AI_STUDIO
summary: Cancel Session
description: Cancel an active AI playground session
operationId: cancel_session_studio_cancel_post
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: navigationSource
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Navigationsource
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: true
title: Request
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/studio/agents:
get:
tags:
- AI_STUDIO
summary: List Agents
description: 'List all production agents from Langfuse.
Fetches the agent names from the ''agent-names'' prompt config,
then retrieves full details (name, version, prompt, config, labels) for each agent.'
operationId: list_agents_studio_agents_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListAgentsResponse'
security:
- HTTPBearer: []
post:
tags:
- AI_STUDIO
summary: Create Or Update Agent
description: 'Create or update an agent definition in Langfuse.
Note: We use create_prompt for both create and update because:
- create_prompt automatically creates a new version if the name exists
- update_prompt only modifies labels on existing versions, not content'
operationId: create_or_update_agent_studio_agents_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAgentRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAgentResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
deprecated: true
security:
- HTTPBearer: []
delete:
tags:
- AI_STUDIO
summary: Delete Agent
description: Deprecate an agent by removing it from production and marking as deprecated.
operationId: delete_agent_studio_agents_delete
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteAgentRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/BaseResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
deprecated: true
security:
- HTTPBearer: []
/studio/agents/{agent_name}:
get:
tags:
- AI_STUDIO
summary: Get Agent
description: Get an agent definition from Langfuse.
operationId: get_agent_studio_agents__agent_name__get
security:
- HTTPBearer: []
parameters:
- name: agent_name
in: path
required: true
schema:
type: string
title: Agent Name
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/GetAgentResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/studio/agents/production/add:
post:
tags:
- AI_STUDIO
summary: Add Agent To Production
description: Add an agent to the production agents list (agent-names config.agents).
operationId: add_agent_to_production_studio_agents_production_add_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AddAgentToProductionRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/BaseResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
deprecated: true
security:
- HTTPBearer: []
/studio/agents/production/remove:
post:
tags:
- AI_STUDIO
summary: Remove Agent From Production
description: Remove an agent from the production agents list (agent-names config.agents).
operationId: remove_agent_from_production_studio_agents_production_remove_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RemoveAgentFromProductionRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/BaseResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
components:
schemas:
SessionToPdfRequest:
properties:
session_id:
type: string
title: Session Id
type: object
required:
- session_id
title: SessionToPdfRequest
RemoveAgentFromProductionRequest:
properties:
name:
type: string
title: Name
type: object
required:
- name
title: RemoveAgentFromProductionRequest
ListAgentsResponse:
properties:
agents:
items:
$ref: '#/components/schemas/AgentListItem'
type: array
title: Agents
type: object
required:
- agents
title: ListAgentsResponse
DestinationType:
type: string
enum:
- email
- slack
- multi
title: DestinationType
description: 'How to deliver the scheduled report.
Derived from `destination_config` at save time — `MULTI` means both
emails and a Slack webhook are configured on the same schedule.'
Session:
properties:
session_id:
type: string
title: Session Id
name:
type: string
title: Name
created_at:
type: string
format: date-time
title: Created At
updated_at:
type: string
format: date-time
title: Updated At
knowledge:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Knowledge
datamates:
anyOf:
- items:
type: integer
type: array
- type: 'null'
title: Datamates
status:
anyOf:
- $ref: '#/components/schemas/SessionStatusEnum'
- type: 'null'
session_intent:
anyOf:
- type: string
- type: 'null'
title: Session Intent
type: object
required:
- session
# --- truncated at 32 KB (57 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/altimate-ai/refs/heads/main/openapi/altimate-ai-ai-studio-api-openapi.yml