Superinterface
Product
Pricing
Examples
Docs
Blog
GitHub
Discord
Book a demo
Sign in
Menu
Getting started
AI Provider Setup
OpenAI
Anthropic
Azure OpenAI
FAQ
Assistants
Create assistant
Functions
API Request
Client tool
Firecrawl
Multi-agents
Tasks
Interfaces
Create interface
Interaction Modes
Realtime Voice Chat
Text-to-Speech Voice Chat
AI Builder
Publish interface
Components
Annotations
Concepts
Why Superinterface
How it works
Tasks
Overview
API reference
React
Installation
Components
Hooks
JavaScript
REST
Assistants
Initial messages
AI providers
GET
List AI providers
POST
Create AI provider
GET
Get an AI provider
PATCH
Update AI provider
DELETE
Delete AI provider
API keys
Messages
Tasks
Get an AI provider
Get the details of an existing AI provider.
Request
GET
https
:
//superinterface.ai/api/cloud/providers/{providerId}
Authentication
Include your
private
API key in the request headers:
Authorization
:
Bearer
YOUR_PRIVATE_API_KEY
Path Parameters
Parameter
Type
Description
providerId
string
The ID of an existing AI provider
Example request
curl
-
X
GET
"
https://superinterface.ai/api/cloud/providers/30cfe680-fee5-49b9-b386-6a7097eb8497
"
\
-
H
"
Authorization: Bearer YOUR_PRIVATE_API_KEY
"
\
-
H
"
Content-Type: application/json
"
Response
Parameter
Type
Description
provider
Provider
Existing
Provider
Example response
{
"
provider
"
:
{
"
id
"
:
"
114a170b-9770-4dcf-9f18-8b464482e41d
"
,
"
type
"
:
"
OPENAI
"
,
"
name
"
:
"
"
,
"
apiKey
"
:
"
sk-proj-IOKBKQJumIfonGrYWcA
"
,
"
endpoint
"
:
null
,
"
apiVersion
"
:
null
,
"
createdAt
"
:
"
2024-01-15T10:30:00Z
"
,
"
updatedAt
"
:
"
2024-01-15T10:30:00Z
"
}
}
Errors
The endpoint may return the following errors:
401 Unauthorized
This error occurs if the API key is invalid or missing.
{
"
error
"
:
"
Unauthorized
"
,
"
message
"
:
"
Invalid or missing API key
"
}
Status
Changelog
Terms of service
Privacy policy