Aiden
Aiden API Access

Aiden APIs

authentication aiden api uses api key authentication api keys are in the format aiden \<key> and should be included in the authorization header authorization bearer aiden \<key> api keys can be managed through the api keys page each api key is associated with a specific user and customer api endpoints all apis are available under https //aiden opsverse io/api/ ask post /v1/ask send a question to aiden and receive a streaming response post /v1/ask request body { "query" "string", "conversationid" "uuid" (optional) } response a streaming response that contains a json object with the following fields { "response" "string", "skill" { "id" "string", "name" "string" }, "conversationid" "string", "interactionid" "string" } example curl x post "https //aiden opsverse io/api/v1/ask" \\ h "authorization bearer aiden \<your api key>" \\ h "content type application/json" \\ d '{ "query" "what is the current cpu usage of my ec2 instances?" }' skills get /v1/skills returns a list of all skills available to the authenticated user get /v1/skills query parameters include global boolean (optional) whether to include global skills include disabled boolean (optional) whether to include disabled skills response { "skills" \[ { "id" "uuid", "name" "string", "description" "string", "skill steps" \[ { "agent" "string", "action" "string", "parameters" \[{}] } ], "is enabled" "boolean", "is global" "boolean", "created at" "datetime", "updated at" "datetime" } ] } example curl x get "https //aiden opsverse io/api/v1/skills?include global=true" \\ h "authorization bearer aiden \<your api key>" get v1/skills/{id} returns details of a specific skill get /v1/skills/{id} parameters id uuid of the skill response { "id" "uuid", "name" "string", "description" "string", "skill steps" \[ { "agent" "string", "action" "string", "parameters" \[{}] } ], "is enabled" "boolean", "is global" "boolean", "created at" "datetime", "updated at" "datetime" } example curl x get "https //aiden opsverse io/api/v1/skills/550e8400 e29b 41d4 a716 446655440000" \\ h "authorization bearer aiden \<your api key>" post /v1/skills creates a new skill post /v1/skills request body { "name" "string", "description" "string", "skill steps" \[ { "agent" "string", "action" "string", "parameters" \[{}] } ], "is global" "boolean" (optional) } response { "id" "uuid", "name" "string", "description" "string", "skill steps" \[ { "agent" "string", "action" "string", "parameters" \[{}] } ], "is enabled" "boolean", "is global" "boolean", "created at" "datetime", "updated at" "datetime" } example curl x post "https //aiden opsverse io/api/v1/skills" \\ h "authorization bearer aiden \<your api key>" \\ h "content type application/json" \\ d '{ "name" "aws ec2 instance analyzer", "description" "analyzes ec2 instances for performance and cost optimization", "skill steps" \[ { "agent" "aws expert", "action" "fetch all ec2 instances and their details", "parameters" \[{}] }, { "agent" "aws expert", "action" "analyze instances for optimization opportunities", "parameters" \[{}] } ] }' pathch /v1/skills/{id} updates an existing skill patch /v1/skills/{id} parameters id uuid of the skill request body { "name" "string" (optional), "description" "string" (optional), "skill steps" \[ { "agent" "string", "action" "string", "parameters" \[{}] } ] (optional), "is enabled" "boolean" (optional), "is global" "boolean" (optional) } response { "id" "uuid", "name" "string", "description" "string", "skill steps" \[ { "agent" "string", "action" "string", "parameters" \[{}] } ], "is enabled" "boolean", "is global" "boolean", "created at" "datetime", "updated at" "datetime" } example curl x patch "https //aiden opsverse io/api/v1/skills/550e8400 e29b 41d4 a716 446655440000" \\ h "authorization bearer aiden \<your api key>" \\ h "content type application/json" \\ d '{ "name" "updated aws ec2 instance analyzer", "is enabled" true }' delete /v1/skills/{id} deletes a skill delete /v1/skills/{id} parameters id uuid of the skill response { "status" "ok" } example curl x delete "https //aiden opsverse io/api/v1/skills/550e8400 e29b 41d4 a716 446655440000" \\ h "authorization bearer aiden \<your api key>" integrations get /v1/integrations returns a list of all available integrations and currently configured integrations for the authenticated user's organization get /v1/integrations response { "integrations" \[ { "name" "string", "description" "string", "is enabled" "boolean", "allow multiple" "boolean", "is global" "boolean", "icon" "string" } ], "configurations" \[ { "id" "uuid", "integration type" "string", "parameters" "string", "is enabled" "boolean" } ] } example curl x get "https //aiden opsverse io/api/v1/integrations" \\ h "authorization bearer aiden \<your api key>" get /v1/integrations/{id} returns details of a specific integration configuration get /v1/integrations/{id} parameters id uuid of the integration configuration response { "id" "uuid", "integration type" "string", "parameters" "string", "is enabled" "boolean" } example curl x get "https //aiden opsverse io/api/v1/integrations/550e8400 e29b 41d4 a716 446655440000" \\ h "authorization bearer aiden \<your api key>" post /v1/integrations creates a new integration configuration post /v1/integrations request body { "integration type" "string", "parameters" "object", "create prebuilt skills" "boolean" } response { "id" "uuid", "integration type" "string", "parameters" "object", "is enabled" "boolean" } example curl x post "https //aiden opsverse io/api/v1/integrations" \\ h "authorization bearer aiden \<your api key>" \\ h "content type application/json" \\ d '{ "integration type" "aws", "parameters" { "aws access key id" "your access key", "aws secret access key" "your secret key", "aws region" "us west 2" }, "create prebuilt skills" true }' patch /v1/integrations/{id} updates an existing integration configuration patch /v1/integrations/{id} parameters id uuid of the integration configuration request body { "parameters" "object" (optional), "is enabled" "boolean" (optional) } response { "id" "uuid", "integration type" "string", "parameters" "object", "is enabled" "boolean" } example curl x patch "https //aiden opsverse io/api/v1/integrations/550e8400 e29b 41d4 a716 446655440000" \\ h "authorization bearer aiden \<your api key>" \\ h "content type application/json" \\ d '{ "parameters" { "aws access key id" "updated access key", "aws secret access key" "updated secret key", "aws region" "us east 1" }, "is enabled" true }' delete integration delete /api/v1/integrations/{id} deletes an integration configuration parameters id uuid of the integration configuration response { "status" "ok" } example curl x delete "https //aiden opsverse io/api/v1/integrations/550e8400 e29b 41d4 a716 446655440000" \\ h "authorization bearer aiden \<your api key>" knowledge base the knowledge base api allows you to manage contextual information that aiden can use to provide more personalized and relevant responses get /v1/context returns the knowledge base context for the authenticated user's organization get /v1/context response { "basecontext" "string" } example curl x get "https //aiden opsverse io/api/v1/context" \\ h "authorization bearer aiden \<your api key>" post /v1/context creates or updates the knowledge base context for the authenticated user's organization this endpoint automatically processes the context into embeddings for semantic search post /v1/context request body { "basecontext" "string" } response { "status" "ok" } example curl x post "https //aiden opsverse io/api/v1/context" \\ h "authorization bearer aiden \<your api key>" \\ h "content type application/json" \\ d '{ "basecontext" "this is important knowledge for aiden to use when answering questions our organization uses aws ec2 instances in us west 2 region primarily for web applications, and rds for postgresql databases " }'