Skip to content
Agent as a BusinessAgent as a Business Documentation

api_app_retrieve

GET
/api/app/{slug}/
curl --request GET \
  --url https://example.com/api/app/example/ \
  --header 'Authorization: <Authorization>'

Manage applications and all related operations.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
slug
required
string

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json

Unified application serializer for creation and detail views.

object
id
required
string format: uuid
name
required
string
<= 100 characters
slug
required
string
/^[-a-zA-Z0-9_]+$/
description
string
type
required
  • prompt - Prompt
  • workflow - Workflow
string
Allowed values: prompt workflow
type_display
required
string
status
  • draft - Draft
  • live - Live
  • archived - Archived
string
Allowed values: draft live archived
status_display
required
string
visibility
  • private - Private
  • public - Public
  • embed - Embed
string
Allowed values: private public embed
visibility_display
required
string
price_cents
integer
>= -2147483648 <= 2147483647
tags
creator
required
object
id
required
string format: uuid
email
required
string format: email
<= 254 characters
display_name
required
string
<= 100 characters
plan
  • free - Free
  • pro - Pro
  • enterprise - Enterprise
string
Allowed values: free pro enterprise
credits
integer
>= -2147483648 <= 2147483647
created_at
required
string format: date-time
updated_at
required
string format: date-time
created_at
required
string format: date-time
updated_at
required
string format: date-time
Example
{
  "type": "prompt",
  "status": "draft",
  "visibility": "private",
  "creator": {
    "plan": "free"
  }
}