Get an AI platform connector

GET 
https://api.vectorize.io/v1/org/:organizationId/connectors/aiplatforms/:aiplatformId

Get an AI platform connector

Request

Path Parameters

organization stringrequired
aiplatformId stringrequired

Responses

200

Get an AI platform connector

application/json

Schema

Schema

idstringrequired
typestringrequired
namestringrequired
configDoc object
createdAtstringnullable
createdByIdstring
lastUpdatedByIdstring
createdByEmailstring
lastUpdatedByEmailstring
errorMessagestring
verificationStatusstring

Example (auto)

{
  "id": "string",
  "type": "string",
  "name": "string",
  "configDoc": {},
  "createdAt": "string",
  "createdById": "string",
  "lastUpdatedById": "string",
  "createdByEmail": "string",
  "lastUpdatedByEmail": "string",
  "errorMessage": "string",
  "verificationStatus": "string"
}

Example

{
  "id": "ef419fbe-81c3-4319-b8bc-5f12ebf8698a",
  "type": "example-type",
  "name": "My AIPlatform",
  "configDoc": {},
  "createdAt": "example-createdAt",
  "createdById": "77625475-bf5a-4e44-85e0-71c28623a749",
  "lastUpdatedById": "dde4790c-3e54-4644-bda8-bd475a83f850",
  "createdByEmail": "user@example.com",
  "lastUpdatedByEmail": "user@example.com",
  "errorMessage": "Operation completed successfully",
  "verificationStatus": "verified"
}

400

Invalid request

application/json

Schema

Schema

errorstringrequired
detailsstring
failedUpdatesstring[]
successfulUpdatesstring[]

Example (auto)

{
  "error": "string",
  "details": "string",
  "failedUpdates": [
    "string"
  ],
  "successfulUpdates": [
    "string"
  ]
}

Example

{
  "error": "An error occurred",
  "details": "example-details",
  "failedUpdates": [],
  "successfulUpdates": []
}

401

Unauthorized

application/json

Schema

Schema

errorstringrequired
detailsstring
failedUpdatesstring[]
successfulUpdatesstring[]

Example (auto)

{
  "error": "string",
  "details": "string",
  "failedUpdates": [
    "string"
  ],
  "successfulUpdates": [
    "string"
  ]
}

Example

{
  "error": "An error occurred",
  "details": "example-details",
  "failedUpdates": [],
  "successfulUpdates": []
}

403

Forbidden

application/json

Schema

Schema

errorstringrequired
detailsstring
failedUpdatesstring[]
successfulUpdatesstring[]

Example (auto)

{
  "error": "string",
  "details": "string",
  "failedUpdates": [
    "string"
  ],
  "successfulUpdates": [
    "string"
  ]
}

Example

{
  "error": "An error occurred",
  "details": "example-details",
  "failedUpdates": [],
  "successfulUpdates": []
}

404

Not found

application/json

Schema

Schema

errorstringrequired
detailsstring
failedUpdatesstring[]
successfulUpdatesstring[]

Example (auto)

{
  "error": "string",
  "details": "string",
  "failedUpdates": [
    "string"
  ],
  "successfulUpdates": [
    "string"
  ]
}

Example

{
  "error": "An error occurred",
  "details": "example-details",
  "failedUpdates": [],
  "successfulUpdates": []
}

500

Internal server error

application/json

Schema

Schema

errorstringrequired
detailsstring
failedUpdatesstring[]
successfulUpdatesstring[]

Example (auto)

{
  "error": "string",
  "details": "string",
  "failedUpdates": [
    "string"
  ],
  "successfulUpdates": [
    "string"
  ]
}

Example

{
  "error": "An error occurred",
  "details": "example-details",
  "failedUpdates": [],
  "successfulUpdates": []
}

Authorization: http

name: bearerAuthtype: httpscheme: bearerbearerFormat: JWT

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.vectorize.io/v1/org/:organizationId/connectors/aiplatforms/:aiplatformId");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.vectorize.io/v1

Auth

Bearer Token

Parameters

organization — pathrequired

aiplatformId — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!