All-Images.ai
My Account
  • Welcome
  • All-Images.ai API
    • Overview
    • Authentication
    • Errors
    • Pagination
    • API Reference
      • Images
      • Images generation
      • API Keys
      • API Keys Webhook
    • API Explorer
  • Integration guide
    • Image generation
      • Create Image generation
      • Lifecycle of Image generation
    • Webhooks
      • Image generation
  • Changelog
    • API
Powered by GitBook
On this page

Was this helpful?

  1. All-Images.ai API
  2. API Reference

API Keys

PreviousImages generationNextAPI Keys Webhook

Last updated 1 year ago

Was this helpful?

Check API Key

Create Endpoint Webhook

Remove Webhook

Get Webhook

Check the validity of current use api key

get
Header parameters
api-keystringRequired
Responses
200Success
application/json
400Error
500Error
get
GET /v1/api-keys/check HTTP/1.1
Host: 
api-key: text
Accept: */*
{
  "email": "text",
  "name": "text"
}

Remove webhook endpoint from an API key

delete
Path parameters
apiWebhookIdstringRequired
Header parameters
api-keystringRequired
Responses
201Success
400Error
500Error
delete
DELETE /v1/api-keys/webhook/unsubscribe/{apiWebhookId} HTTP/1.1
Host: 
api-key: text
Accept: */*

No content

Get webhook from its ID

get
Path parameters
apiKeyWebhookIdstringRequired
Header parameters
api-keystringRequired
Responses
201Success
400Error
500Error
get
GET /v1/api-keys/webhook/{apiKeyWebhookId} HTTP/1.1
Host: 
api-key: text
Accept: */*

No content

  • Check API Key
  • GETCheck the validity of current use api key
  • Create Endpoint Webhook
  • POSTAdd webhook endpoint to an API key
  • Remove Webhook
  • DELETERemove webhook endpoint from an API key
  • Get Webhook
  • GETGet webhook from its ID

Add webhook endpoint to an API key

post
Header parameters
api-keystringRequired
Body
urlstringRequired
Responses
201Success
application/json
400Error
500Error
post
POST /v1/api-keys/webhook/subscribe HTTP/1.1
Host: 
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "url": "text",
  "events": [
    "test"
  ]
}
{
  "webhookId": "text"
}