developer.requestIndexing

POST

/v1/developer/indexing

curl --request POST \
  --url https://example.com/v1/developer/indexing \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "cardUrl": "example" }'

Authorizations

• token
• session

Request Body^required

Media typeapplication/json

object

cardUrl

required

string

Example ^generated

{
  "cardUrl": "example"
}

Responses

200

Success

Media typeapplication/json

object

id

required

string

cardUrl

required

string

generation

required

string

acceptedAt

required

number

status

required

string

Allowed values: Accepted Waiting Verifying Completed

check

required

Any of:

object

Any of:

object

object

_tag

required

string

Allowed values: Pending

object

object

_tag

required

string

Allowed values: Indexed

attemptedAt

required

number

object

object

_tag

required

string

Allowed values: Excluded

attemptedAt

required

number

reason

required

string

object

object

_tag

required

string

Allowed values: Withdrawn

attemptedAt

required

number

reason

required

string

object

object

_tag

required

string

Allowed values: Unconfirmed

attemptedAt

required

number

reason

required

string

object

object

_tag

required

string

Allowed values: Failed

attemptedAt

required

number

reason

required

string

null

null

restriction

required

Any of:

object

object

cardUrl

required

string

reason

required

string

>= 1 characters

appealUrl

required

string

null

null

Example

{
  "status": "Accepted",
  "check": {
    "_tag": "Pending"
  }
}

400

DeveloperInputInvalid | OrganizationRequired

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: DeveloperInputInvalid

message

required

string

keys

Array<string>

object

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "DeveloperInputInvalid"
}

401

AuthenticationRequired

Media typeapplication/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

DeveloperRestricted | DeveloperForbidden | PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: DeveloperRestricted

restriction

required

object

cardUrl

required

string

reason

required

string

>= 1 characters

appealUrl

required

string

object

object

_tag

required

string

Allowed values: DeveloperForbidden

object

object

_tag

required

string

Allowed values: PermissionDenied

permission

required

string

Allowed values: responses.run sessions.read sessions.write requests.resolve agents.read agents.write agents.delegate connections.read connections.write apps.use apps.publish models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read

resource

required

string

object

object

_tag

required

string

Allowed values: MembershipRequired

object

object

_tag

required

string

Allowed values: ForbiddenOrigin

Example

{
  "_tag": "DeveloperRestricted"
}

404

DeveloperNotFound

Media typeapplication/json

object

_tag

required

string

Allowed values: DeveloperNotFound

Example

{
  "_tag": "DeveloperNotFound"
}

409

DeveloperConflict

Media typeapplication/json

object

_tag

required

string

Allowed values: DeveloperConflict

reason

required

string

Example

{
  "_tag": "DeveloperConflict"
}

503

DeveloperUnavailable | AuthorizationUnavailable | AuthenticationUnavailable

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: DeveloperUnavailable

object

object

_tag

required

string

Allowed values: AuthorizationUnavailable

object

object

_tag

required

string

Allowed values: AuthenticationUnavailable

Example

{
  "_tag": "DeveloperUnavailable"
}