API docs by Redocly

ai API (develop:c14720)

Download OpenAPI specification:

License: None

Automatically generated swagger spec for the ai stack.

AdvertGenerationService

AdvertGenerationService_GetAccountConfig

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "config": {
    }
}

AdvertGenerationService_SetAccountConfig

path Parameters
accountId
required
string <int64>
Request Body schema: application/json
required
prompt
string

Responses

Request samples

Content type
application/json
{
  • "prompt": "string"
}

Response samples

Content type
application/json
{
  • "config": {
    }
}

AdvertGenerationService_SubmitGenerationFeedback

Request Body schema: application/json
required
comment
string

Optional free text. Does not trigger regeneration by itself.

generationId
required
string
rating
required
string (advert_generationFeedbackRating)
Default: "FEEDBACK_RATING_UNDEFINED"
Enum: "FEEDBACK_RATING_UNDEFINED" "FEEDBACK_RATING_POSITIVE" "FEEDBACK_RATING_NEGATIVE"

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "generationId": "string",
  • "rating": "FEEDBACK_RATING_UNDEFINED"
}

Response samples

Content type
application/json
{
  • "feedback": {
    }
}

AdvertGenerationService_Generate

Request Body schema: application/json
required
objectId
required
string

Responses

Request samples

Content type
application/json
{
  • "objectId": "string"
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "generationId": "string",
  • "parentGenerationId": "string",
  • "requestId": "string",
  • "title": "string"
}

AdvertGenerationService_Regenerate

Request Body schema: application/json
required
feedback
required
string

Revision instruction appended as a user turn after the previous assistant output.

generationId
required
string

Prior generation to revise. Account prompt and object data are reloaded server-side.

Responses

Request samples

Content type
application/json
{
  • "feedback": "string",
  • "generationId": "string"
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "generationId": "string",
  • "parentGenerationId": "string",
  • "requestId": "string",
  • "title": "string"
}

AiGatewayService

AiGatewayService_GetAccountSettings

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "settings": {
    }
}

AiGatewayService_SetAccountSettings

path Parameters
accountId
required
string <int64>
Request Body schema: application/json
required
enabled
boolean
enabledUseCases
Array of strings (ai_gatewayAiUseCase)
Items Enum: "AI_USE_CASE_UNDEFINED" "AI_USE_CASE_CLAIM_MANAGEMENT" "AI_USE_CASE_ADVERT_DESCRIPTION"

Use cases enabled for this account. When enabled=true and empty, all registered use cases are allowed.

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "enabledUseCases": [
    ]
}

Response samples

Content type
application/json
{
  • "settings": {
    }
}

AiGatewayService_ListUsageRecords

Request Body schema: application/json
required
accountId
required
string <int64>
filterUseCases
Array of strings (ai_gatewayAiUseCase)
Items Enum: "AI_USE_CASE_UNDEFINED" "AI_USE_CASE_CLAIM_MANAGEMENT" "AI_USE_CASE_ADVERT_DESCRIPTION"

Optional. If empty, include all use cases.

fromUnix
required
string <int64>

Start of period (inclusive), UNIX seconds.

pageSize
required
integer <int32>

Max records to return. Default 50, max 500.

pageToken
required
string

Opaque cursor from previous response.

toUnix
required
string <int64>

End of period (exclusive), UNIX seconds.

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "filterUseCases": [
    ],
  • "fromUnix": "string",
  • "pageSize": 0,
  • "pageToken": "string",
  • "toUnix": "string"
}

Response samples

Content type
application/json
{
  • "nextPageToken": "string",
  • "records": [
    ],
  • "totalCount": 0
}

AiGatewayService_GetQuota

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "quotas": [
    ]
}

AiGatewayService_SetQuota

path Parameters
accountId
required
string <int64>
Request Body schema: application/json
required
Array of objects (ai_gatewayAiQuota)

Responses

Request samples

Content type
application/json
{
  • "quotas": [
    ]
}

Response samples

Content type
application/json
{
  • "quotas": [
    ]
}

AiGatewayService_GetUsage

path Parameters
accountId
required
string <int64>
query Parameters
fromUnix
string <int64>

Start of period (inclusive), UNIX seconds.

toUnix
string <int64>

End of period (exclusive), UNIX seconds.

filterUseCases
Array of strings
Items Enum: "AI_USE_CASE_UNDEFINED" "AI_USE_CASE_CLAIM_MANAGEMENT" "AI_USE_CASE_ADVERT_DESCRIPTION"

Optional. If empty, aggregate across all use cases.

Responses

Response samples

Content type
application/json
{
  • "summary": {
    }
}