Text to Image Search | Coactive AI

1 curl -X POST https://api.coactive.ai/api/v1/search/text-to-image \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "dataset_id": "12345678-abcd-90ef-1234-56789abcdef0", 6 "text_query": "sunset at the beach", 7 "offset": 0, 8 "limit": 100, 9 "metadata_filters": { 10 "filters": [ 11 { 12 "key": "location", 13 "operator": "==", 14 "value": "Hawaii" 15 } 16 ] 17 }, 18 "asset_type": "video" 19 }'

1 { 2 "data": [ 3 { 4 "created_user_id": "auth0|a1b2c3d4e5f6g7h8i9j0klmn", 5 "created_dt": "2025-02-19T18:58:05.583610Z", 6 "updated_user_id": "auth0|a1b2c3d4e5f6g7h8i9j0klmn", 7 "updated_dt": "2025-02-19T18:58:05.583610Z", 8 "coactive_image_id": "cb701a04-7a02-417d-9705-7f532e86b2d9", 9 "path": "s3://bucket/assets/sunset1.jpg", 10 "id": null, 11 "metadata": null, 12 "moderation_score": null 13 }, 14 { 15 "created_user_id": "auth0|1234567890abcdef", 16 "created_dt": "2025-02-19T18:58:05.584122Z", 17 "updated_user_id": "auth0|1234567890abcdef", 18 "updated_dt": "2025-02-19T19:12:53.423655Z", 19 "coactive_image_id": "9342e315-6e3b-40b8-a248-41fb887febfb", 20 "path": "s3://bucket/assets/sunset2.jpg", 21 "id": null, 22 "metadata": null, 23 "moderation_score": null 24 } 25 ] 26 }

Performs a search with text query and return a list of image results

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

dataset_idstringRequiredformat: "uuid4"

The unique identifier for the dataset

text_querystringRequired

The text query to search for

offsetinteger or any or nullOptional

Starting index to return

limitinteger or any or nullOptional

Max number of items to return

metadata_filtersobject or any or nullOptional

List of metadata filters to apply to the search

asset_typeenum or nullOptional

The asset type to filter results by. If no asset type is selected the endpoint will search over images and videos

skip_moderationbooleanOptionalDefaults to false

Skip content moderation if enabled

Response

Successful Response

datalist of any

The paginated results

Authentication

Request

Response

Errors