`GET /v1/tools/{name}`

Read the selected owned resource or current workflow state without starting a new generation.

Request example#

curl 'https://platform.tongai.io/v1/tools/tong_image_upload' \  -H "Authorization: Bearer $TONG_API_KEY"

Configuration

curl --version

Authentication#

Use a server-side API key for your account, or OAuth for each customer’s account. Never send keys in prompts or tool arguments.

catalog:read

Parameters#

namestringRequired

Allowed values"tong_image_upload""tong_reference_upload""tong_video_upload""tong_audio_reference_upload""tong_director_document_upload""tong_director_reference_upload""tong_lora_media_upload""tong_motion_video_upload""tong_motion_image_upload""tong_video_edit_upload""tong_workflows""tong_director_config""tong_audio_config""tong_video_editor_config""tong_motion_config""tong_lora_config""tong_library_search""tong_asset_download""tong_workspace_list""tong_workspace_get""tong_workspace_create""tong_conversation_create""tong_conversation_get""tong_conversation_messages""tong_generation_reuse""tong_generation_quote""tong_generation_submit""tong_director_continuity_read""tong_director_projects""tong_director_get""tong_director_video_attach""tong_director_draft_create""tong_director_script_save""tong_director_planning_quote""tong_director_planning_submit""tong_director_planning_status""tong_director_estimate""tong_director_shots_reorder""tong_director_shot_select""tong_director_frame_approve""tong_director_shot_delete""tong_director_shots_quote""tong_director_shots_submit""tong_director_resume""tong_director_export""tong_reference_read""tong_reference_import""tong_reference_direction""tong_reference_quote""tong_reference_submit""tong_reference_script_edit""tong_reference_script_accept""tong_cast_read""tong_cast_quote""tong_cast_submit""tong_cast_select""tong_cast_use""tong_locations_prepare""tong_locations_quote""tong_locations_submit""tong_location_select""tong_director_video_edit_quote""tong_director_video_edit_submit""tong_video_source_prepare""tong_video_selection_quote""tong_video_edit_quote""tong_video_edit_route_quote""tong_video_selection_frame""tong_video_selection_mask""tong_video_edit_submit""tong_video_edit_job""tong_motion_submit""tong_motion_job""tong_lora_submit""tong_lora_job""tong_motion_quote""tong_lora_catalog""tong_lora_quote""tong_audio_quote""tong_audio_submit""tong_remix_prepare""tong_remix_create""tong_remix_get""tong_remix_update""tong_remix_export""tong_remix_export_status""tong_composition_config""tong_composition_render""tong_composition_get""tong_composition_lookup""tong_composition_cancel""tong_assets_list""tong_asset_get""tong_asset_delete""tong_assets_delete""tong_workspace_rename""tong_workspace_delete""tong_workspace_attach""tong_workspace_detach""tong_workspace_films""tong_characters_list""tong_character_create""tong_character_update""tong_character_delete""tong_subjects_list""tong_subject_get""tong_subject_create""tong_subject_delete""tong_conversations_list""tong_conversation_update""tong_conversation_delete""tong_generation_alternative_quote""tong_generation_alternative_submit""tong_generation_retry""tong_director_create""tong_director_update""tong_director_delete""tong_director_note""tong_director_method""tong_director_models""tong_director_shot_add""tong_director_shot_update""tong_director_frame_attach""tong_director_shot_release""tong_cast_rename""tong_location_assign""tong_location_attach""tong_video_edit_jobs""tong_motion_jobs""tong_lora_jobs""tong_video_edit_resume""tong_motion_resume""tong_motion_reuse_image""tong_video_draft_get""tong_video_draft_save""tong_video_presets""tong_lora_reference_get""tong_lora_image_get""tong_lora_reference_delete""tong_lora_save""tong_lora_unsave""tong_lora_import""tong_lora_job_delete""tong_lora_estimate""tong_audio_preview""tong_remix_list""tong_enhancement_config""tong_enhancement_get""tong_enhancement_submit""tong_saved_job_follow""tong_text_models""tong_text_history""tong_text_quote""tong_text_submit""tong_assistant_start""tong_filmmaker_start"

Request body#

This endpoint has no request body.

Response schema#

Response

JSON

{}

`HTTP 200`

application/json

object

Errors and limits#

HTTP	Error	Recovery
`400`	Invalid request`REQUEST_INVALID`	Correct the fields identified by the error before trying again.
`401`	Invalid credential`CREDENTIAL_INVALID`	Check the credential, its expiry and whether it has been revoked.
`402`	Insufficient credits`INSUFFICIENT_CREDITS`	Add credits to the account that owns the credential, then continue the saved work.
`403`	Permission denied`SCOPE_REQUIRED`	Use a credential with the required scopes and access to the selected resource.
`404`	Resource unavailable`RESOURCE_UNAVAILABLE`	Check the resource ID and that it belongs to the authorized account.
`409`	Intent conflict`IDEMPOTENCY_CONFLICT`	Reuse an intent only with its original request. Use a new UUID for a different action.
`429`	Rate limited`RATE_LIMITED`	Wait for Retry-After before retrying the same intended request.
`503`	Temporarily unavailable`DEPENDENCY_UNAVAILABLE`	Wait for Retry-After and retry with the same intent. Check the saved operation after a timeout.

AuthenticationAPI keys charge the account that owns the key. OAuth lets each connected user use their own credits.Errors and rate limitsUnderstand error responses, retry safely and recover from failed generations.Requests and logsAn accepted request is not a finished generation. Track the saved job until its output is ready.