Skip to content
UltimateTeam.ai Docs

Request a new service connector

POST
/api/v1/forge/connector
curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/forge/connector \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "additional_info": "example", "service_name": "example" }'

Dispatch a ConnectorForge build job and return a job_id to poll for status.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
ForgeConnectorRequest

Request body for POST /forge/connector.

Attributes: service_name: The service to connect (e.g. ‘Wave Accounting’). additional_info: Optional extra context for the build.

object
additional_info
Any of:
string
service_name
required
Service Name

Name of the service to build a connector for

string
>= 1 characters
Examplegenerated
{
  "additional_info": "example",
  "service_name": "example"
}

Responses

Section titled “ Responses ”

202

Section titled “202”

Successful Response

Media typeapplication/json
ForgeJobAcceptedEnvelope

Typed envelope for POST /forge/agent and POST /forge/connector (202).

object
data
required
ForgeJobAccepted

Envelope returned on successful job submission (202).

Attributes: job_id: UUID of the queued forge job. status: Always ‘pending’ at submission time.

object
job_id
required
Job Id
string
status
Status
string
default: pending
Example
{
  "data": {
    "status": "pending"
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}