Jump to

• Request
• Response

Preview agent card

post

/20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/agents/actions/previewAgentCard

Returns the agent card based on the given agent card configuration.

Request

Path Parameters

• aiDataPlatformId(required): string
  Minimum Length: 1

  Maximum Length: 500

  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• workspaceKey(required): string
  Minimum Length: 1

  Maximum Length: 200

  The key of the Workspace

Header Parameters

• if-match: string
  Maximum Length: 1000

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
• opc-request-id: string
  Maximum Length: 255

  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
• opc-retry-token: string
  Maximum Length: 64

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might be rejected.
• should-update-recent: boolean
  A flag to identify if the recent list should be updated.

  Default Value: false

Body ()

Request details for previewing an agent card

Root Schema : PreviewAgentCardDetails

Type: object

Details for previewing an agent card.

Show Source

• agentCardConfigDetails(required): object AgentCardConfigDetail
  Details of the A2A publish request payload.

{
    "description":"Details for previewing an agent card.",
    "type":"object",
    "required":[
        "agentCardConfigDetails"
    ],
    "properties":{
        "agentCardConfigDetails":{
            "$ref":"#/definitions/AgentCardConfigDetail"
        }
    }
}

Nested Schema : AgentCardConfigDetail

Type: object

Details of the A2A publish request payload.

Show Source

• capabilities: object AgentCardCapabilitiesDetail
  Capabilities included in publish request.
• description: string
  Maximum Length: 1048576

  Human-readable agent description.
• documentationUrl: string
  Documentation URL for the agent. Serialized as `documentation_url`.
• name(required): string
  Minimum Length: 1

  Maximum Length: 255

  Human-readable agent name.
• provider: object AgentProvider
  Service provider information for an agent.
• skills: array skills
  List of skills supported by the agent.
• version: string
  Agent version string.

{
    "description":"Details of the A2A publish request payload.",
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Human-readable agent name.",
            "minLength":1,
            "maxLength":255
        },
        "description":{
            "type":"string",
            "description":"Human-readable agent description.",
            "maxLength":1048576
        },
        "skills":{
            "type":"array",
            "description":"List of skills supported by the agent.",
            "items":{
                "$ref":"#/definitions/AgentCardSkillDetail"
            }
        },
        "capabilities":{
            "$ref":"#/definitions/AgentCardCapabilitiesDetail"
        },
        "version":{
            "type":"string",
            "description":"Agent version string."
        },
        "provider":{
            "$ref":"#/definitions/AgentProvider"
        },
        "documentationUrl":{
            "type":"string",
            "description":"Documentation URL for the agent. Serialized as `documentation_url`."
        }
    }
}

Nested Schema : AgentCardCapabilitiesDetail

Type: object

Capabilities included in publish request.

Show Source

• isStreaming: boolean
  Indicates whether streaming responses are supported.

{
    "description":"Capabilities included in publish request.",
    "type":"object",
    "properties":{
        "isStreaming":{
            "type":"boolean",
            "description":"Indicates whether streaming responses are supported."
        }
    }
}

Nested Schema : AgentProvider

Type: object

Service provider information for an agent.

Show Source

• organization: string
  The name of the agent provider's organization.
• url: string
  A URL for the agent provider's website or documentation.

{
    "description":"Service provider information for an agent.",
    "type":"object",
    "properties":{
        "organization":{
            "type":"string",
            "description":"The name of the agent provider's organization."
        },
        "url":{
            "type":"string",
            "description":"A URL for the agent provider's website or documentation."
        }
    }
}

Nested Schema : skills

Type: array

List of skills supported by the agent.

Show Source

• Array of: object AgentCardSkillDetail
  A single skill in the publish request.

{
    "type":"array",
    "description":"List of skills supported by the agent.",
    "items":{
        "$ref":"#/definitions/AgentCardSkillDetail"
    }
}

Nested Schema : AgentCardSkillDetail

Type: object

A single skill in the publish request.

Show Source

• description: string
  Maximum Length: 1048576

  Description of what the skill does.
• examples: array examples
  Optional example prompts for this skill.
• id(required): string
  Minimum Length: 1

  Maximum Length: 255

  Unique skill identifier.
• name(required): string
  Minimum Length: 1

  Maximum Length: 255

  Display name of the skill.
• tags: array tags
  Optional tags for categorization/search.

{
    "description":"A single skill in the publish request.",
    "type":"object",
    "required":[
        "id",
        "name"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique skill identifier.",
            "minLength":1,
            "maxLength":255
        },
        "name":{
            "type":"string",
            "description":"Display name of the skill.",
            "minLength":1,
            "maxLength":255
        },
        "description":{
            "type":"string",
            "description":"Description of what the skill does.",
            "maxLength":1048576
        },
        "tags":{
            "type":"array",
            "description":"Optional tags for categorization/search.",
            "items":{
                "type":"string",
                "minLength":1,
                "maxLength":255
            }
        },
        "examples":{
            "type":"array",
            "description":"Optional example prompts for this skill.",
            "items":{
                "type":"string",
                "minLength":1,
                "maxLength":1048576
            }
        }
    }
}

Nested Schema : examples

Type: array

Optional example prompts for this skill.

Show Source

• Array of: string
  Minimum Length: 1

  Maximum Length: 1048576

{
    "type":"array",
    "description":"Optional example prompts for this skill.",
    "items":{
        "type":"string",
        "minLength":1,
        "maxLength":1048576
    }
}

Nested Schema : tags

Type: array

Optional tags for categorization/search.

Show Source

• Array of: string
  Minimum Length: 1

  Maximum Length: 255

{
    "type":"array",
    "description":"Optional tags for categorization/search.",
    "items":{
        "type":"string",
        "minLength":1,
        "maxLength":255
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : AgentCardPreviewResponse

Type: object

Response for previewing an agent card.

Show Source

• agentCardJson(required): string
  JSON string representation of AgentCard

{
    "description":"Response for previewing an agent card.",
    "type":"object",
    "required":[
        "agentCardJson"
    ],
    "properties":{
        "agentCardJson":{
            "type":"string",
            "description":"JSON string representation of AgentCard"
        }
    }
}

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested resource was not found.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

409 Response

Conflict. Request conflicts with the current state of the resource.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

412 Response

Precondition Failed (One or more conditions in request failed).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests. Too many requests sent to the server in a short period.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Default Response

Unknown Error. Error is not recognized by the system.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Back to Top