ModelCredentialRequest

A credential to create, or what an existing one should become. On an update every field is replaced. Keys are matched by id: an existing key sent with its id and no value is kept as it is, a key sent with a value is stored, and an existing key left out is removed.

Kind: an object, used in requests.

Fields

Field	Type	Description
`name`	`string`
`description`	`string \| null`
`provider`	`ModelKeyProvider`
`endpoint`	`string \| null`	An HTTPS endpoint on the public internet; null for the provider’s public API.
`cloud`	`CredentialCloudInput\| null`	For an Anthropic credential: Claude on Amazon Bedrock (with `awsRegion`) or Google Vertex AI (with `gcpProjectId` and `gcpRegion`), with no `endpoint`. The key is then the Bedrock API key, or the service account’s JSON key file. Only code pipelines’ Claude Code agents run on it.
`keys`	`ModelCredentialKeyRequest[]`
`models`	`CredentialModelInput[]`
`tag`	`string \| null`

Example

{
  "name": "...",
  "description": "...",
  "provider": "Anthropic",
  "endpoint": "...",
  "cloud": {
    "kind": "Bedrock",
    "awsRegion": "...",
    "gcpProjectId": "...",
    "gcpRegion": "..."
  },
  "keys": [
    {
      "id": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
      "value": "..."
    }
  ],
  "models": [
    {
      "model": "...",
      "deploymentName": "...",
      "contextWindowTokens": 0
    }
  ],
  "tag": "..."
}

Where it’s used

credentials.create (POST /credentials)
credentials.testUnsaved (POST /credentials/test)
credentials.update (PUT /credentials/by-id/{id})