Skip to main content
API docs by Redocly

Amplified attentionAI API (1.0.0)

Download OpenAPI specification:Download

creatives

Everything about your creatives

Add a new creative.

Add a new creative.

Request Body schema:

Create a new creative

downloadableUrl
required
string

A public URL where the creative file can be accessed and downloaded if applicable.

webhookUrl
required
string

A URL provided by the user to receive asynchronous notifications about the creative processing status and results.

Responses

Request samples

Content type
{}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "fileName": "test.mp4",
  • "fileSource": "external_downloadable_link",
  • "downloadableUrl": "test.mp4",
  • "fileSize": 10,
  • "adLength": 6,
  • "aspectRatio": 969,
  • "webhookUrl": "https://app.amplified.co/webhook",
  • "status": "uploaded",
  • "createdAt": "string",
  • "updatedAt": "string"
}

Get all creatives

Returns all registered creative assets and their metadata for easy tracking and management.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Find creative by ID.

Retrieves metadata for a specific creative using its creativeId.

path Parameters
creativeId
required
string

ID of creative to return

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "fileName": "test.mp4",
  • "fileSource": "external_downloadable_link",
  • "downloadableUrl": "test.mp4",
  • "fileSize": 10,
  • "adLength": 6,
  • "aspectRatio": 969,
  • "webhookUrl": "https://app.amplified.co/webhook",
  • "status": "uploaded",
  • "createdAt": "string",
  • "updatedAt": "string"
}

Delete a creative

Removes a specific creative(including its file & results), identified by creativeId.

path Parameters
creativeId
required
string

Creative id to delete

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Delete a creative file

Removes the file associated with a specific creative, identified by creativeId.

path Parameters
creativeId
required
string

Creative id to delete

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Create a creative by uploading a file

Creates a new creative by uploading a video file directly (mp4 or mov, ≤5MB) with optional targeting details for prediction jobs.

Request Body schema:
webhookUrl
required
string

A URL provided by the user to receive asynchronous notifications about the creative processing status and results.

Responses

Request samples

Content type
{}

Response samples

Content type
application/json
{
  • "code": 0,
  • "type": "string",
  • "message": "string"
}

Get synthetic audience data by creativeId.

Returns synthetic audience data.

path Parameters
creativeId
required
string

ID of creative to return

Responses

Response samples

Content type
application/json
{
  • "creative": {
    },
  • "resultDownloadLink": "https://attention-ai.amplified.co/download/abc.csv",
  • "syntheticData": [
    ]
}

Find Webhook notifications by creative ID.

Returns a list of notifications.

path Parameters
creativeId
required
string

ID of creative to return

Responses

Response samples

Content type
application/json
[
  • {
    }
]

accounts

Account details

Fetch service usage details.

Fetch service usage details.

Responses

Response samples

Content type
application/json
[
  • {
    }
]