> ## Documentation Index
> Fetch the complete documentation index at: https://docs.formal.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# CreateConnectorAiProvider

> Connector AI Provider



## OpenAPI

````yaml /docs/api/openapi/connectors_openapi.json post /core.v1.ConnectorService/CreateConnectorAiProvider
openapi: 3.1.0
info:
  title: core.v1.ConnectorService
  version: 0.0.1
servers:
  - url: https://api.joinformal.com
    description: Production API
security: []
tags:
  - name: core.v1.ConnectorService
paths:
  /core.v1.ConnectorService/CreateConnectorAiProvider:
    post:
      tags:
        - core.v1.ConnectorService
      summary: CreateConnectorAiProvider
      description: Connector AI Provider
      operationId: core.v1.ConnectorService.CreateConnectorAiProvider
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/core.v1.CreateConnectorAiProviderRequest'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/core.v1.CreateConnectorAiProviderResponse'
        '400':
          description: Bad Request - Invalid request parameters or body
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    example: invalid_request
                  message:
                    type: string
                    example: Invalid request parameters
                  details:
                    type: object
        '401':
          description: Unauthorized - Missing or invalid authentication
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    example: unauthorized
                  message:
                    type: string
                    example: Authentication required
        '403':
          description: Forbidden - Insufficient permissions
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    example: forbidden
                  message:
                    type: string
                    example: Insufficient permissions to perform this action
        '404':
          description: Not Found - Resource does not exist
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    example: not_found
                  message:
                    type: string
                    example: Resource not found
        '500':
          description: Internal Server Error - An error occurred processing the request
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    example: internal_error
                  message:
                    type: string
                    example: An internal error occurred
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: cURL
          source: >-
            curl -X POST
            "https://api.joinformal.com/core.v1.ConnectorService/CreateConnectorAiProvider"
            \
              -H "X-API-KEY: YOUR_API_KEY" \
              -H "Content-Type: application/json" \
              -d '{
                "example": "value"
              }'
        - lang: javascript
          label: JavaScript (fetch)
          source: >-
            fetch("https://api.joinformal.com/core.v1.ConnectorService/CreateConnectorAiProvider",
            {
              method: "POST",
              headers: {
                "X-API-KEY": "YOUR_API_KEY",
                "Content-Type": "application/json"
              },
              body: JSON.stringify({
                example: "value"
              })
            })
              .then(response => response.json())
              .then(data => console.log(data))
              .catch(error => console.error(error));
        - lang: python
          label: Python
          source: >-
            import requests


            url =
            "https://api.joinformal.com/core.v1.ConnectorService/CreateConnectorAiProvider"

            headers = {
                "X-API-KEY": "YOUR_API_KEY",
                "Content-Type": "application/json"
            }

            data = {
                "example": "value"
            }


            response = requests.post(url, headers=headers, json=data)

            print(response.json())
        - lang: go
          label: Go
          source: |-
            package main

            import (
                "bytes"
                "encoding/json"
                "fmt"
                "io"
                "net/http"
            )

            func main() {
                url := "https://api.joinformal.com/core.v1.ConnectorService/CreateConnectorAiProvider"

                body := map[string]string{
                    "example": "value",
                }

                jsonData, _ := json.Marshal(body)

                req, _ := http.NewRequest("POST", url, bytes.NewBuffer(jsonData))
                req.Header.Set("X-API-KEY", "YOUR_API_KEY")
                req.Header.Set("Content-Type", "application/json")

                client := &http.Client{}
                resp, err := client.Do(req)
                if err != nil {
                    panic(err)
                }
                defer resp.Body.Close()

                responseBody, _ := io.ReadAll(resp.Body)
                fmt.Println(string(responseBody))
            }
components:
  schemas:
    core.v1.CreateConnectorAiProviderRequest:
      type: object
      properties:
        connectorId:
          type: string
          title: connector_id
          minLength: 1
        config:
          $ref: '#/components/schemas/core.v1.ConnectorAiProviderConfig'
          title: config
      title: CreateConnectorAiProviderRequest
      required:
        - config
      additionalProperties: false
    core.v1.CreateConnectorAiProviderResponse:
      type: object
      properties:
        connectorAiProvider:
          $ref: '#/components/schemas/core.v1.ConnectorAiProvider'
          title: connector_ai_provider
      title: CreateConnectorAiProviderResponse
      additionalProperties: false
    core.v1.ConnectorAiProviderConfig:
      type: object
      properties:
        anthropic:
          $ref: '#/components/schemas/core.v1.AnthropicConfig'
          title: anthropic
          description: One of the discriminated union fields - use exactly one
        awsBedrock:
          $ref: '#/components/schemas/core.v1.AwsBedrockConfig'
          title: aws_bedrock
          description: One of the discriminated union fields - use exactly one
        azureAi:
          $ref: '#/components/schemas/core.v1.AzureAiConfig'
          title: azure_ai
          description: One of the discriminated union fields - use exactly one
        formalAiSatellite:
          $ref: '#/components/schemas/core.v1.FormalAiSatelliteConfig'
          title: formal_ai_satellite
          description: One of the discriminated union fields - use exactly one
        gemini:
          $ref: '#/components/schemas/core.v1.GeminiConfig'
          title: gemini
          description: One of the discriminated union fields - use exactly one
        googleVertexAi:
          $ref: '#/components/schemas/core.v1.GoogleVertexAiConfig'
          title: google_vertex_ai
          description: One of the discriminated union fields - use exactly one
        openai:
          $ref: '#/components/schemas/core.v1.OpenAiConfig'
          title: openai
          description: One of the discriminated union fields - use exactly one
      title: ConnectorAiProviderConfig
      additionalProperties: false
      description: >-
        Exactly one of these fields is required: anthropic or aws_bedrock or
        azure_ai or formal_ai_satellite or gemini or google_vertex_ai or openai.
    core.v1.ConnectorAiProvider:
      type: object
      properties:
        id:
          type: string
          title: id
        connectorId:
          type: string
          title: connector_id
        config:
          $ref: '#/components/schemas/core.v1.ConnectorAiProviderConfig'
          title: config
        createdAt:
          $ref: '#/components/schemas/google.protobuf.Timestamp'
          title: created_at
        updatedAt:
          $ref: '#/components/schemas/google.protobuf.Timestamp'
          title: updated_at
      title: ConnectorAiProvider
      additionalProperties: false
      description: Entity
    core.v1.AnthropicConfig:
      type: object
      properties:
        apiKey:
          type: string
          title: api_key
          minLength: 1
      title: AnthropicConfig
      additionalProperties: false
    core.v1.AwsBedrockConfig:
      type: object
      properties:
        region:
          type: string
          title: region
          minLength: 1
      title: AwsBedrockConfig
      additionalProperties: false
    core.v1.AzureAiConfig:
      type: object
      properties:
        apiKey:
          type: string
          title: api_key
          minLength: 1
        endpoint:
          type: string
          title: endpoint
          minLength: 1
      title: AzureAiConfig
      additionalProperties: false
    core.v1.FormalAiSatelliteConfig:
      type: object
      title: FormalAiSatelliteConfig
      additionalProperties: false
    core.v1.GeminiConfig:
      type: object
      properties:
        apiKey:
          type: string
          title: api_key
          minLength: 1
      title: GeminiConfig
      additionalProperties: false
    core.v1.GoogleVertexAiConfig:
      type: object
      properties:
        gcpProjectId:
          type: string
          title: gcp_project_id
          minLength: 1
        region:
          type: string
          title: region
          minLength: 1
      title: GoogleVertexAiConfig
      additionalProperties: false
    core.v1.OpenAiConfig:
      type: object
      properties:
        apiKey:
          type: string
          title: api_key
          minLength: 1
      title: OpenAiConfig
      additionalProperties: false
    google.protobuf.Timestamp:
      type: string
      examples:
        - '2023-01-15T01:30:15.01Z'
        - '2024-12-25T12:00:00Z'
      format: date-time
      description: >-
        A Timestamp represents a point in time independent of any time zone or
        local
         calendar, encoded as a count of seconds and fractions of seconds at
         nanosecond resolution. The count is relative to an epoch at UTC midnight on
         January 1, 1970, in the proleptic Gregorian calendar which extends the
         Gregorian calendar backwards to year one.

         All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
         second table is needed for interpretation, using a [24-hour linear
         smear](https://developers.google.com/time/smear).

         The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
         restricting to that range, we ensure that we can convert to and from [RFC
         3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.

         # Examples

         Example 1: Compute Timestamp from POSIX `time()`.

             Timestamp timestamp;
             timestamp.set_seconds(time(NULL));
             timestamp.set_nanos(0);

         Example 2: Compute Timestamp from POSIX `gettimeofday()`.

             struct timeval tv;
             gettimeofday(&tv, NULL);

             Timestamp timestamp;
             timestamp.set_seconds(tv.tv_sec);
             timestamp.set_nanos(tv.tv_usec * 1000);

         Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.

             FILETIME ft;
             GetSystemTimeAsFileTime(&ft);
             UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

             // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
             // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
             Timestamp timestamp;
             timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
             timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

         Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.

             long millis = System.currentTimeMillis();

             Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
                 .setNanos((int) ((millis % 1000) * 1000000)).build();

         Example 5: Compute Timestamp from Java `Instant.now()`.

             Instant now = Instant.now();

             Timestamp timestamp =
                 Timestamp.newBuilder().setSeconds(now.getEpochSecond())
                     .setNanos(now.getNano()).build();

         Example 6: Compute Timestamp from current time in Python.

             timestamp = Timestamp()
             timestamp.GetCurrentTime()

         # JSON Mapping

         In JSON format, the Timestamp type is encoded as a string in the
         [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
         format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
         where {year} is always expressed using four digits while {month}, {day},
         {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
         seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
         are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
         is required. A proto3 JSON serializer should always use UTC (as indicated by
         "Z") when printing the Timestamp type and a proto3 JSON parser should be
         able to accept both UTC and other timezones (as indicated by an offset).

         For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
         01:30 UTC on January 15, 2017.

         In JavaScript, one can convert a Date object to this format using the
         standard
         [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
         method. In Python, a standard `datetime.datetime` object can be converted
         to this format using
         [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
         the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
         the Joda Time's [`ISODateTimeFormat.dateTime()`](
         http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime()
         ) to obtain a formatter capable of generating timestamps in this format.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: API key authentication. Get your API key from the Formal console.

````