Anakin.ai API
  1. QuickApp
Anakin.ai API
  • Getting started
  • API Versions
  • Apps
    • Chatbot
      • Conversation with Chatbot
    • QuickApp
      • Run a Quick App
        POST
  • Meta
    • Get all API versions
      GET
  1. QuickApp

Run a Quick App

POST
/v1/quickapps/{appId}/runs
Transmit inputs to a QuickApp's pre-prompting instructions which used to generate an AI output. And the output is determined by the pre-prompting instructions.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.anakin.ai/v1/quickapps/1476/runs' \
--header 'X-Anakin-Api-Version;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "inputs": {
        "Topic": "About Artificial Intelligence",
        "Details": "Driving Customer Engagement"
    },
    "stream": true
}'
Response Response Example
200 - Non-streaming response - Success
{
  "content": "Anakin.ai is a one-stop AI app platform that offers the ability to generate content, images, videos, and voice, as well as craft automated workflows, custom AI apps, and intelligent agents.",
  "threadId": "NRwJqQ6yBE4vG9c4UwILV6N1VVsZppjA"
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
appId
string 
required
Example:
1476
Header Params
X-Anakin-Api-Version
string 
required
The Anakin.ai API is versioned. The API version name is based on the date when the API version was released.
Default:
2024-05-06
Body Params application/json
inputs
object 
required
A template's inputs. The required inputs for the given template should match it's input label, which are available in the App's Run panel
Additional properties
integer  | number  | string  | boolean 
optional
stream
boolean 
optional
Whether to stream back partial progress. If true, returns a stream of events that happen during the conversation as server-sent events, terminating when the conversation enters a terminal state with a data: [DONE] message.
Default:
false
Examples

Responses

🟢200Non-streaming response
application/json
Body
Represents an AI generated response returned by model, based on the provided input.
content
MessageContent
required
The content of the message in array of text and/or images.
One of
The text contents of the message.
threadId
string 
required
The ID of the thread to which this message belongs.
Threads and Messages represent a conversation session.
🟢200Streaming response
Modified at 2024-07-26 03:44:39
Previous
Conversation with Chatbot
Next
Get all API versions
Built with