Vapi · Schema

GcpCredential

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
provider string
fallbackIndex number This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order.
id string This is the unique identifier for the credential.
orgId string This is the unique identifier for the org that this credential belongs to.
createdAt string This is the ISO 8601 date-time string of when the credential was created.
updatedAt string This is the ISO 8601 date-time string of when the assistant was last updated.
name string This is the name of credential. This is just for your reference.
gcpKey object This is the GCP key. This is the JSON that can be generated in the Google Cloud Console at https://console.cloud.google.com/iam-admin/serviceaccounts/details//keys. The schema is i
region string This is the region of the GCP resource.
bucketPlan object
View JSON Schema on GitHub

JSON Schema

vapi-gcpcredential-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GcpCredential",
  "title": "GcpCredential",
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "gcp"
      ]
    },
    "fallbackIndex": {
      "type": "number",
      "description": "This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order.",
      "minimum": 1
    },
    "id": {
      "type": "string",
      "description": "This is the unique identifier for the credential."
    },
    "orgId": {
      "type": "string",
      "description": "This is the unique identifier for the org that this credential belongs to."
    },
    "createdAt": {
      "format": "date-time",
      "type": "string",
      "description": "This is the ISO 8601 date-time string of when the credential was created."
    },
    "updatedAt": {
      "format": "date-time",
      "type": "string",
      "description": "This is the ISO 8601 date-time string of when the assistant was last updated."
    },
    "name": {
      "type": "string",
      "description": "This is the name of credential. This is just for your reference.",
      "minLength": 1,
      "maxLength": 40
    },
    "gcpKey": {
      "description": "This is the GCP key. This is the JSON that can be generated in the Google Cloud Console at https://console.cloud.google.com/iam-admin/serviceaccounts/details/<service-account-id>/keys.\n\nThe schema is identical to the JSON that GCP outputs.",
      "allOf": [
        {
          "$ref": "#/components/schemas/GcpKey"
        }
      ]
    },
    "region": {
      "type": "string",
      "description": "This is the region of the GCP resource.",
      "maxLength": 40
    },
    "bucketPlan": {
      "$ref": "#/components/schemas/BucketPlan"
    }
  },
  "required": [
    "provider",
    "id",
    "orgId",
    "createdAt",
    "updatedAt",
    "gcpKey"
  ]
}