TikiAPI
Images, video, voice and music from your AI assistant. Pay per result, no subscription.
¿Debería usar esto?
Calidad y seguridad
Hallazgos (1)
- LOWen get_account
Basado en el análisis automatizado de las definiciones de herramientas y el cumplimiento del protocolo.
Costo de contexto
Este es el número aproximado de tokens que se consumen cada vez que las herramientas del servidor se cargan en el contexto de un modelo. Los recuentos más altos reducen la atención disponible para otras tareas.
Instalar
Instalación con un clic
Agrega esto a tu archivo `claude_desktop_config.json`:
{
"mcpServers": {
"mcp": {
"url": "https://mcp.tikiapi.com/mcp"
}
}
}Puntos de conexión remotos
https://mcp.tikiapi.com/mcpstreamable-httpQué puede hacer
Inventario de herramientas
Herramientas (18)
🟢list_models(kind)
Models with their limits and prices in USD: the public catalog before sign-in, this account's own after. Free. Empty fields are left out: no max_reference_images means the model takes no reference images. Text (chat) models are left out unless kind is text: they run over REST (POST /v1/chat/completions), not through these tools.
Esquema de entrada
{
"type": "object",
"properties": {
"kind": {
"description": "Only models of this kind: video, image, audio (music, sound effects, speech) or text.",
"type": "string",
"enum": [
"video",
"image",
"audio",
"text"
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"object": {
"type": "string",
"const": "list"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"kind": {
"type": "string",
"description": "video, image, audio or text"
},
"pricing": {
"type": "array",
"items": {
"type": "object",
"properties": {
"unit": {
"type": "string"
},
"usd": {
"type": "string",
"description": "US dollars, for example 0.84"
},
"promo_until": {
"description": "While a promo is on: when it ends (ISO, UTC).",
"type": "string"
},
"list_usd": {
"description": "While a promo is on: the price it goes back to.",
"type": "string"
}
},
"required": [
"unit",
"usd"
],
"additionalProperties": {}
}
}
},
"required": [
"id",
"name",
"kind",
"pricing"
],
"additionalProperties": {}
}
}
},
"required": [
"object",
"data"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": {}
}🟢estimate_cost(model, aspect_ratio, resolution, duration, image_urls, ...)
The price of an order before placing it: the same fields, the same checks and the same price as generate (see its fields). Nothing is made and nothing is charged. Before sign-in: the public price (reference videos, audio and characters need sign-in, since their seconds and photos count); after: this account's price and balance.
Esquema de entrada
{
"type": "object",
"properties": {
"model": {
"type": "string"
},
"aspect_ratio": {
"type": "string"
},
"resolution": {
"type": "string"
},
"duration": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"image_urls": {
"type": "array",
"items": {
"type": "string"
}
},
"video_urls": {
"type": "array",
"items": {
"type": "string"
}
},
"audio_urls": {
"type": "array",
"items": {
"type": "string"
}
},
"image_mode": {
"type": "string",
"enum": [
"reference",
"first_frame",
"first_last_frame"
]
},
"audio": {
"type": "boolean"
},
"lyrics": {
"type": "string"
},
"style": {
"type": "string"
},
"instrumental": {
"type": "boolean"
},
"fast": {
"type": "boolean"
},
"audio_mode": {
"type": "string",
"enum": [
"parallel",
"sequential"
]
},
"speaker_boxes": {
"type": "array",
"items": {
"type": "array",
"prefixItems": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
],
"items": false,
"minItems": 4,
"maxItems": 4
}
},
"character_id": {
"type": "string"
},
"character_ids": {
"maxItems": 2,
"type": "array",
"items": {
"type": "string"
}
},
"prompt": {
"type": "string"
}
},
"required": [
"model"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"object": {
"type": "string",
"const": "estimate"
},
"model": {
"type": "string"
},
"kind": {
"type": "string"
},
"price": {
"type": "string",
"description": "What this order costs"
},
"promo_until": {
"description": "A promo price: when it ends (ISO, UTC). An order placed before then keeps this price.",
"type": "string"
},
"list_price": {
"description": "A promo price: the price after promo_until.",
"type": "string"
},
"can_order_now": {
"type": "boolean"
},
"charge": {
"description": "With a key or sign-in: what the order would take from the balance (0 for a test key).",
"type": "string"
},
"available_balance": {
"type": "string",
"description": "US dollars, for example 0.84"
},
"enough_balance": {
"type": "boolean"
}
},
"required": [
"object",
"model",
"kind",
"price",
"can_order_now"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": {}
}🟡upload_media(mode, data, url, bytes, filename, ...)
Stores a file of your own (PNG, JPEG or WebP image, MP4 or MOV video, MP3 or WAV audio) and returns a link and an id, either one for image_urls, video_urls or audio_urls (and create_character, edit_video). Three ways in: data — the file as base64 here (up to 20 MB); prepare — a signed link to PUT the file to yourself, with a ready curl command (videos up to 50 MB; best for big files, no base64 in the chat); url — we fetch a public link. Kept 48 hours, then deleted.
Esquema de entrada
{
"type": "object",
"properties": {
"mode": {
"description": "How the file comes. data (default): base64 here, up to 20 MB. prepare: a signed link you PUT the file to yourself (a ready curl command comes back): videos up to 50 MB, images 20 MB, audio 15 MB — best for big files and whenever you have a shell, no base64. url: we fetch a public https link ourselves.",
"type": "string",
"enum": [
"data",
"prepare",
"url"
]
},
"data": {
"description": "mode data: the file, base64-encoded (a data: URL works too).",
"type": "string"
},
"url": {
"description": "mode url: a public https link to the file itself.",
"type": "string"
},
"bytes": {
"description": "mode prepare: the file's exact size in bytes (for example: wc -c < file). The link takes exactly this many.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"filename": {
"description": "The file's name; in mode prepare its extension gives the type when content_type is left out.",
"type": "string"
},
"content_type": {
"description": "mode prepare: the file's type, for example image/png, video/mp4, audio/mpeg. Other modes read the type from the file itself.",
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"object": {
"type": "string",
"const": "upload"
},
"id": {
"type": "string"
},
"kind": {
"type": "string"
},
"url": {
"type": "string"
},
"content_type": {
"type": "string"
},
"bytes": {
"type": "number"
},
"expires_at": {
"type": "string"
}
},
"required": [
"object",
"id",
"kind",
"url",
"content_type",
"bytes",
"expires_at"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": {}
}🟢list_generations(limit, before)
This account's orders, newest first, with their status, price and result links. Pass next as before for older ones.
Esquema de entrada
{
"type": "object",
"properties": {
"limit": {
"description": "How many, 1–100 (default 20).",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"before": {
"description": "An order id: list the ones before it (the next value of the previous page).",
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"object": {
"type": "string",
"const": "list"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"object": {
"type": "string",
"const": "generation"
},
"model": {
"type": "string"
},
"status": {
"type": "string",
"description": "queued, running, succeeded, failed or canceled"
},
"price": {
"type": "string",
"description": "US dollars, for example 0.84"
},
"charged": {
"type": "string",
"description": "US dollars, for example 0.84"
},
"outputs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"content_type": {
"type": "string"
}
},
"required": [
"url",
"content_type"
],
"additionalProperties": {}
},
"description": "The results: links on our CDN."
},
"error": {
"description": "Why it failed, or null."
}
},
"required": [
"id",
"object",
"model",
"status",
"price",
"charged",
"outputs",
"error"
],
"additionalProperties": {}
}
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"object",
"data",
"next"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": {}
}🟢generate(model, aspect_ratio, resolution, duration, image_urls, ...)
Makes an image, a video, a song or a sound effect and waits for it (up to about a minute; a video or a song usually takes longer). A music order gives two takes of the song. Spends the account balance; a failed order costs nothing. The answer links each original and shows a small preview (a picture at 1024 px, a clip as 4 frames: look for a white flash or grey blacks at the start). If it is still running, the answer has eta_seconds and poll_after_seconds: check with get_generation then — don't start it again. wait false places it and answers at once with its id: for several pictures at once, collected with one wait_for_generations. Videos: one at a time, each looked at before the next. The same request again within 10 minutes returns the same order (repeated: true), never a second charge: for another variant pass run_again true.
Esquema de entrada
{
"type": "object",
"properties": {
"model": {
"type": "string",
"description": "Model id from list_models."
},
"aspect_ratio": {
"description": "For example 1:1, 16:9, 9:16.",
"type": "string"
},
"resolution": {
"description": "For example 1K, 2K, 4K for images; 720p for video.",
"type": "string"
},
"duration": {
"description": "Seconds: a video's length; a track's (music, optional: the model picks otherwise); a sound effect's (default 5, priced by the second).",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"image_urls": {
"description": "Reference images: public https links, or upload_media links or ids.",
"type": "array",
"items": {
"type": "string"
}
},
"video_urls": {
"description": "Reference videos (MP4/MOV): public https links, or upload_media links or ids. Video models only; their seconds are billed too.",
"type": "array",
"items": {
"type": "string"
}
},
"audio_urls": {
"description": "Reference audio (MP3/WAV): public https links, or upload_media links or ids. Video models only, free; most need an image or a video next to it. Lip-sync models (lip_sync in list_models): the speech the photo says, one file per person in it (make it with speak); the clip runs as long as the speech.",
"type": "array",
"items": {
"type": "string"
}
},
"image_mode": {
"description": "Video: how image_urls are used. reference (default) — things to bring in; first_frame — the clip opens on the one image; first_last_frame — opens on the first, ends on the second.",
"type": "string",
"enum": [
"reference",
"first_frame",
"first_last_frame"
]
},
"audio": {
"description": "Video: false for a silent clip, where the model allows it (audio_optional in list_models).",
"type": "boolean"
},
"lyrics": {
"description": "Music: the words to sing, as written (sections like [Verse], [Chorus] help). Leave out for the model to write them from the prompt.",
"type": "string"
},
"style": {
"description": "Music: genre, mood, instruments, voice, for example lo-fi hip hop, warm Rhodes, female vocal.",
"type": "string"
},
"instrumental": {
"description": "Music: true for no vocals.",
"type": "boolean"
},
"fast": {
"description": "The model's faster mode at the same price, where list_models shows fast_mode (LongCat: about 10% quicker, the picture may change a little).",
"type": "boolean"
},
"audio_mode": {
"description": "Lip sync (lip_sync in list_models) with two people in one photo and two audio files, one per person (the first is the person on the left). parallel: both tracks share one timeline and are the same length, each silent while the other person speaks: any number of turns. sequential: the first track in full, then the second. Left out: parallel when the two run the same length, sequential otherwise.",
"type": "string",
"enum": [
"parallel",
"sequential"
]
},
"speaker_boxes": {
"description": "Lip sync with two speakers, optional: where each person is, [x_min, y_min, x_max, y_max] in the photo's pixels, in the order of audio_urls. Left out: the first track is the person on the left, the second the one on the right.",
"type": "array",
"items": {
"type": "array",
"prefixItems": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
],
"items": false,
"minItems": 4,
"maxItems": 4
}
},
"character_id": {
"description": "A saved person (create_character): their photos go first among the references and the prompt opens with an identity block. Don't describe their face or hair in the prompt; put the framing first (close-up, medium shot): a small face drifts. Your own image_urls come after their photos. References only: not with image_mode first_frame.",
"type": "string"
},
"character_ids": {
"description": "Two saved people in one order, instead of character_id.",
"maxItems": 2,
"type": "array",
"items": {
"type": "string"
}
},
"prompt": {
"type": "string",
"description": "What to make."
},
"run_again": {
"description": "Make another one even if the same request was just made.",
"type": "boolean"
},
"wait": {
"description": "true (default): wait for the result, up to about a minute. false: answer at once with the order's id; collect it with wait_for_generations or get_generation.",
"type": "boolean"
}
},
"required": [
"model",
"prompt"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"object": {
"type": "string",
"const": "generation"
},
"model": {
"type": "string"
},
"status": {
"type": "string",
"description": "queued, running, succeeded, failed or canceled"
},
"price": {
"type": "string",
"description": "US dollars, for example 0.84"
},
"charged": {
"type": "string",
"description": "US dollars, for example 0.84"
},
"outputs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"content_type": {
"type": "string"
}
},
"required": [
"url",
"content_type"
],
"additionalProperties": {}
},
"description": "The results: links on our CDN."
},
"error": {
"description": "Why it failed, or null."
},
"eta_seconds": {
"description": "While it runs: about how many seconds are left.",
"type": [
"number",
"null"
]
},
"poll_after_seconds": {
"description": "While it runs: when to check again with get_generation.",
"type": "number"
},
"message": {
"type": "string"
},
"repeated": {
"description": "true: this is an order placed a few minutes ago with the same request, not a new one (see repeat_note).",
"type": "boolean"
},
"repeat_note": {
"type": "string"
}
},
"required": [
"id",
"object",
"model",
"status",
"price",
"charged",
"outputs",
"error"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": {}
}🟢get_generation(id)
An order's status and result: links to the originals and a small preview to look at. While it runs: eta_seconds (likely time left) and poll_after_seconds (when to check again).
Esquema de entrada
{
"type": "object",
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"object": {
"type": "string",
"const": "generation"
},
"model": {
"type": "string"
},
"status": {
"type": "string",
"description": "queued, running, succeeded, failed or canceled"
},
"price": {
"type": "string",
"description": "US dollars, for example 0.84"
},
"charged": {
"type": "string",
"description": "US dollars, for example 0.84"
},
"outputs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"content_type": {
"type": "string"
}
},
"required": [
"url",
"content_type"
],
"additionalProperties": {}
},
"description": "The results: links on our CDN."
},
"error": {
"description": "Why it failed, or null."
},
"eta_seconds": {
"description": "While it runs: about how many seconds are left.",
"type": [
"number",
"null"
]
},
"poll_after_seconds": {
"description": "While it runs: when to check again with get_generation.",
"type": "number"
},
"message": {
"type": "string"
},
"repeated": {
"description": "true: this is an order placed a few minutes ago with the same request, not a new one (see repeat_note).",
"type": "boolean"
},
"repeat_note": {
"type": "string"
}
},
"required": [
"id",
"object",
"model",
"status",
"price",
"charged",
"outputs",
"error"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": {}
}🟢get_account
The balance in USD and where to top up.
Esquema de entrada
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"object": {
"type": "string",
"const": "account"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"balance": {
"type": "object",
"properties": {
"currency": {
"type": "string"
},
"total": {
"type": "string",
"description": "US dollars, for example 0.84"
},
"held": {
"type": "string",
"description": "US dollars, for example 0.84"
},
"available": {
"type": "string",
"description": "US dollars, for example 0.84"
}
},
"required": [
"currency",
"total",
"held",
"available"
],
"additionalProperties": {}
},
"top_up_url": {
"type": "string"
}
},
"required": [
"object",
"id",
"name",
"balance",
"top_up_url"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": {}
}🟢speak(text, voice, model, reference_audio_url, reference_text, ...)
Reads text aloud and returns a link to the MP3 (kept 30 days). voice is a free-text direction, e.g. "a warm, amused British narrator"; a [bracketed] cue before a sentence sets its emotion, e.g. "[whispering] It's here.". To clone a voice, give reference_audio_url (MP3 or WAV, 10–30 s of clean speech) and, ideally, reference_text. Billed per character read (the direction too); see list_models. The same request again within 10 minutes returns the same recording, not a second charge.
Esquema de entrada
{
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "What to say. May contain [bracketed] emotion cues."
},
"voice": {
"description": "How it sounds: a free-text voice direction.",
"type": "string"
},
"model": {
"description": "A speech model from list_models (kind audio); the first one when left out.",
"type": "string"
},
"reference_audio_url": {
"description": "A recording to clone the voice from: public https link or an upload_media link.",
"type": "string"
},
"reference_text": {
"description": "What is said in that recording.",
"type": "string"
},
"run_again": {
"description": "Make another take even if the same request was just made.",
"type": "boolean"
}
},
"required": [
"text"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"object": {
"type": "string",
"const": "audio.speech"
},
"status": {
"type": "string",
"description": "succeeded, or running: then call speak again with the same arguments (the same call, no new charge)."
},
"url": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"price": {
"type": "string",
"description": "US dollars, for example 0.84"
},
"charged": {
"type": "string",
"description": "US dollars, for example 0.84"
},
"repeated": {
"type": "boolean"
}
},
"required": [
"object",
"status",
"url"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": {}
}🟡transcribe(url, data, model, language, prompt, ...)
Writes down what is said in a recording, with each segment's start and end in seconds. Give url (a public https link or an upload_media link) or data (the file as base64, up to 20 MB). MP3, WAV, FLAC, OGG, M4A, MP4 or MOV. For captions, pass the answer's id to edit_video as captions { transcription_id } (kept 48 hours); words true also returns every word's timing here. Billed per minute of the recording as we measure it; see list_models. The same request again within 10 minutes is the same call, not a second charge.
Esquema de entrada
{
"type": "object",
"properties": {
"url": {
"description": "The recording: a public https link or an upload_media link.",
"type": "string"
},
"data": {
"description": "Or the file itself, base64-encoded (a data: URL works too).",
"type": "string"
},
"model": {
"description": "A transcription model from list_models (kind audio); the first one when left out.",
"type": "string"
},
"language": {
"description": "ISO-639-1 code, e.g. en; detected when left out.",
"type": "string"
},
"prompt": {
"description": "Spelling hints: names and terms that occur in the recording.",
"type": "string"
},
"words": {
"description": "true: also return every word's start and end (long for a long recording). Default false: captions take the id instead.",
"type": "boolean"
},
"run_again": {
"description": "Transcribe it anew even if the same request was just made.",
"type": "boolean"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "succeeded, or running: then call transcribe again with the same arguments (the same call, no new charge)."
},
"id": {
"description": "Give it to edit_video as captions { transcription_id }.",
"type": "string"
},
"text": {
"type": "string"
},
"price": {
"type": "string",
"description": "US dollars, for example 0.84"
},
"charged": {
"type": "string",
"description": "US dollars, for example 0.84"
},
"repeated": {
"type": "boolean"
}
},
"required": [
"status"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": {}
}🟡edit_video(operation, video_url, aspect_ratio, mode, focus_x, ...)
Edits videos on our servers. reframe: one video to 9:16, 16:9 or 1:1, cropped around a focus point or padded with a blurred copy of itself. assemble: clips joined in order (each optionally trimmed), with an optional audio track over them (music or a voice-over, with its volume and the clips' own volume), optional burned-in captions from a transcribe call (by its id), and loudness brought to -14 LUFS; 1080x1920 or the first clip's size. Inputs: links to generation results (our CDN) or links from upload_media. $0.002 per second of output: the most it can cost is held, the real length is charged; a failed edit costs nothing. Limits: 20 clips of up to 120 s, 180 s of output. Waits about a minute; if still running, check with get_edit (wait_seconds holds until it is done) — don't start it again. The answer shows a sheet of the cut's frames to look at.
Esquema de entrada
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"reframe",
"assemble"
]
},
"video_url": {
"description": "reframe: the video to reframe.",
"type": "string"
},
"aspect_ratio": {
"description": "reframe: the new aspect ratio (required for reframe).",
"type": "string",
"enum": [
"9:16",
"16:9",
"1:1"
]
},
"mode": {
"description": "reframe: crop (default) fills the frame; blur keeps the whole picture on a blurred background.",
"type": "string",
"enum": [
"crop",
"blur"
]
},
"focus_x": {
"description": "reframe, crop: what to keep in view, 0 (left) to 1 (right); default 0.5.",
"type": "number",
"minimum": 0,
"maximum": 1
},
"focus_y": {
"description": "reframe, crop: 0 (top) to 1 (bottom); default 0.5.",
"type": "number",
"minimum": 0,
"maximum": 1
},
"resolution": {
"description": "reframe: output size, default 1080p (1080x1920 for 9:16).",
"type": "string",
"enum": [
"720p",
"1080p"
]
},
"start": {
"description": "reframe: start of the part to keep, seconds.",
"type": "number",
"minimum": 0
},
"end": {
"description": "reframe: end of the part to keep, seconds.",
"type": "number",
"minimum": 0
},
"clips": {
"description": "assemble: the clips in order; start and end (seconds) trim each one.",
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"start": {
"type": "number",
"minimum": 0
},
"end": {
"type": "number",
"minimum": 0
}
},
"required": [
"url"
]
}
},
"audio_url": {
"description": "assemble: an audio track (MP3/WAV/M4A) laid over the clips, cut or padded to their length.",
"type": "string"
},
"audio_volume": {
"description": "assemble: the track's volume, 1 = as is (default).",
"type": "number",
"minimum": 0,
"maximum": 4
},
"audio_start": {
"description": "assemble: where in the track to start, seconds.",
"type": "number",
"minimum": 0
},
"clip_volume": {
"description": "assemble: the clips' own sound, 1 = as recorded (default), 0 = muted.",
"type": "number",
"minimum": 0,
"maximum": 4
},
"captions": {
"description": "assemble: burned-in captions. Best: { transcription_id: \"<id from transcribe>\" } (the voice track's transcript, kept 48 hours). Or the timed words themselves: { words: [{ text, start, end }] } or { segments: [{ text, start, end }] }, times on the output's timeline. Optional style: { position: bottom|middle|top, highlight: true, max_words: 3, uppercase: false }.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"size": {
"description": "assemble: 1080x1920 (default) or the first clip's own size.",
"type": "string",
"enum": [
"1080x1920",
"source"
]
},
"fit": {
"description": "assemble: how clips of another shape fill the frame; blur (default) keeps them whole.",
"type": "string",
"enum": [
"crop",
"blur"
]
},
"run_again": {
"description": "Make another one even if the same request was just made.",
"type": "boolean"
}
},
"required": [
"operation"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"object": {
"type": "string",
"const": "edit"
},
"operation": {
"type": "string"
},
"status": {
"type": "string"
},
"price": {
"anyOf": [
{
"type": "string",
"description": "US dollars, for example 0.84"
},
{
"type": "null"
}
]
},
"charged": {
"type": "string",
"description": "US dollars, for example 0.84"
},
"repeated": {
"description": "true: this is an edit placed a few minutes ago with the same request, not a new one.",
"type": "boolean"
}
},
"required": [
"id",
"object",
"operation",
"status",
"price",
"charged"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": {}
}🟢get_edit(id, wait_seconds)
An edit's status and result (from edit_video): a link to the video and a sheet of its frames to look at. wait_seconds holds the call until it is done.
Esquema de entrada
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"wait_seconds": {
"description": "Wait up to this long for a running edit, 0–50 s (default 0: just look).",
"type": "integer",
"minimum": 0,
"maximum": 50
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"object": {
"type": "string",
"const": "edit"
},
"operation": {
"type": "string"
},
"status": {
"type": "string"
},
"price": {
"anyOf": [
{
"type": "string",
"description": "US dollars, for example 0.84"
},
{
"type": "null"
}
]
},
"charged": {
"type": "string",
"description": "US dollars, for example 0.84"
},
"repeated": {
"description": "true: this is an edit placed a few minutes ago with the same request, not a new one.",
"type": "boolean"
}
},
"required": [
"id",
"object",
"operation",
"status",
"price",
"charged"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": {}
}🟢wait_for_generations(ids, timeout_seconds)
Waits for several orders at once (up to 12 ids, up to 50 s) and returns the finished ones with their results and the ones still running. Use it after generate with wait false, e.g. four pictures placed one after another, then one wait for all of them. If some are still running, call it again with their ids after poll_after_seconds; never order them again.
Esquema de entrada
{
"type": "object",
"properties": {
"ids": {
"minItems": 1,
"maxItems": 12,
"type": "array",
"items": {
"type": "string"
},
"description": "Order ids from generate or list_generations."
},
"timeout_seconds": {
"description": "How long to wait at most, 0–50 s (default 50); 0 just looks.",
"type": "integer",
"minimum": 0,
"maximum": 50
}
},
"required": [
"ids"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": {}
}🟢list_scenarios
Ready-made plans (an ad video end to end, an ad script, a consistent character, a voice-over, a product shoot, a thumbnail and more) with the fields each one asks for. After sign-in, also the skills the person imported into their TikiAPI account: named my-…, marked yours. Free, no sign-in needed.
Esquema de entrada
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"object": {
"type": "string",
"const": "list"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"description": {
"type": "string"
}
},
"required": [
"name",
"required",
"description"
],
"additionalProperties": {}
}
}
},
"required": [
"name",
"title",
"description",
"fields"
],
"additionalProperties": {}
}
}
},
"required": [
"object",
"data"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": {}
}🟢get_scenario(name, fields)
A scenario's worked plan with your fields filled in, for example name "ad-video" with fields { "product": "a reusable coffee cup" }. Follow it step by step: it says where to stop for the person's yes before anything is paid. The models it names are the ones on sale now. The person's own imported skills (my-…, after sign-in) come back as their own instructions; a file that comes with one is name "my-<skill>/<path>". Free, no sign-in needed.
Esquema de entrada
{
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 400,
"description": "The scenario, from list_scenarios; for a file of an imported skill, my-<skill>/<path>."
},
"fields": {
"description": "Its fields as text, by name (list_scenarios shows them).",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"name"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"object": {
"type": "string",
"const": "scenario"
},
"name": {
"type": "string"
},
"title": {
"type": "string"
},
"text": {
"type": "string",
"description": "The worked plan to follow."
}
},
"required": [
"object",
"name",
"title",
"text"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": {}
}🟡create_character(name, face_image, body_image, extra_images, notes)
Saves a person to put into generate by character_id, so their face holds from picture to picture and in video. Give a clean close-up of the face and, separately, a full-length photo — never a front/side/back sheet, which reads as several people. notes (outfit and details) open every prompt with this person. Kept until deleted.
Esquema de entrada
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "What to call them; the prompt names them by it."
},
"face_image": {
"type": "string",
"description": "A clean close-up of the face: a public https link, an upload_media link, or an upload id."
},
"body_image": {
"type": "string",
"description": "A separate full-length photo: a public https link, an upload_media link, or an upload id."
},
"extra_images": {
"description": "Up to 3 more photos of the same person.",
"maxItems": 3,
"type": "array",
"items": {
"type": "string"
}
},
"notes": {
"description": "Outfit and details, for example: black leather jacket, silver ring on the left hand.",
"type": "string"
}
},
"required": [
"name",
"face_image"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"object": {
"type": "string",
"const": "character"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"object",
"name"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": {}
}🟢list_characters
This account's saved people, newest first, with their photos (links work for an hour) and notes.
Esquema de entrada
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"object": {
"type": "string",
"const": "list"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"object": {
"type": "string",
"const": "character"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"object",
"name"
],
"additionalProperties": {}
}
}
},
"required": [
"object",
"data"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": {}
}🔴delete_character(id)
Deletes a saved person and their photos. Orders already made keep their results.
Esquema de entrada
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The character's id."
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"object": {
"type": "string",
"const": "character"
},
"deleted": {
"type": "boolean"
}
},
"required": [
"id",
"object",
"deleted"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": {}
}🟢report_problem(problem, text, ids)
Tells the TikiAPI team about a problem: an order stuck for much longer than its eta_seconds, a charge that looks wrong, a broken result. Give the ids it concerns (orders, edits, speech or transcription calls) and a short description. Use it once per problem, after checking get_generation: a failed order is never charged.
Esquema de entrada
{
"type": "object",
"properties": {
"problem": {
"type": "string",
"enum": [
"stuck_order",
"odd_charge",
"bad_result",
"other"
],
"description": "stuck_order, odd_charge, bad_result or other."
},
"text": {
"type": "string",
"minLength": 1,
"maxLength": 1000,
"description": "What happened, in a few sentences: what was expected and what came back."
},
"ids": {
"description": "The ids it concerns: orders, edits, speech or transcription calls.",
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
}
}
},
"required": [
"problem",
"text"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Esquema de salida
{
"type": "object",
"properties": {
"object": {
"type": "string",
"const": "report"
},
"id": {
"type": "string"
},
"received": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"required": [
"object",
"id",
"received",
"message"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": {}
}Comunidad
Evidencia