Skip to main content
GET
/
api
/
spec
/
{api_name}
Spec Get
curl --request GET \
  --url https://app.apigene.ai/api/spec/{api_name} \
  --header 'Authorization: Bearer <token>'
{
  "api_title": "<string>",
  "api_name": "<string>",
  "api_version": "<string>",
  "created_by": "[email protected]",
  "domain_url": "<string>",
  "server_url": "<string>",
  "server_url_options": [
    "<string>"
  ],
  "examples": [
    "<unknown>"
  ],
  "llm_summary": {},
  "llm_app_categories": {},
  "llm_use_cases_content": [
    "<unknown>"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "security_info": {},
  "security_info_configured": false,
  "operations_state": {},
  "operations_total_count": 0,
  "operations_enabled_count": 0,
  "common_parameters": {},
  "user_input_templates": {},
  "global_spec": false,
  "shared_security_info": false,
  "agentic_metadata": [
    {}
  ]
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Example: 'Authorization: Bearer {token}'

Path Parameters

​
api_name
string
required

Response

Successful Response

Model representing information about a spec.

​
api_title
string
required

The title of the API.

​
api_name
string
required

The name of the API.

​
api_version
string
required

The version of the API.

​
created_by
string<email>
required

Email address of the user who created the spec.

​
domain_url
string | null

The domain URL of the API.

​
server_url
string | null

The server URL of the API.

​
server_url_options
string[] | null

A list of available server URLs for the API.

​
examples
any[] | null

List of examples associated with the API.

​
llm_summary
Llm Summary · object

Summary information generated by LLM (Large Language Model).

​
llm_app_categories
Llm App Categories · object

App categories generated by the LLM.

​
llm_use_cases_content
any[] | null

Use case generated by the LLM.

​
created_at
string<date-time>

The date and time when the spec was created.

​
updated_at
string<date-time>

The date and time when the spec was last updated.

​
security_info
Security Info · object

Information about the security configurations of the API.

​
security_info_configured
boolean
default:false

Flag indicating whether the security information is configured.

​
operations_state
Operations State · object

Information about the state of each operation the spec. support.

​
operations_total_count
integer | null
default:0

Total number of operations the spec. support.

​
operations_enabled_count
integer | null
default:0

Number of operations that are enabled.

​
common_parameters
Common Parameters · object

Name and values of common parameters used in the spec.

​
user_input_templates
User Input Templates · object

User input templates for the operations.

​
global_spec
boolean | null
default:false

Flag indicating whether the spec belong to the tenant or it is a global one.

​
shared_security_info
boolean | null
default:false

Flag indicating whether the spec uses shared security info (global specs only).

​
agentic_metadata
Agentic Metadata · object[] | null

The agentic metadata of the spec.