How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Structify admin API

Admin endpoints

Structify admin API is one of 32 APIs that Structify publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Admin. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 55 operations across 49 paths, and defines 154 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

Requests are made against 2 base URLs: https://api.structify.ai, http://localhost:8080.

55 operations 49 paths 154 schemas 3 DELETE16 GET5 PATCH28 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1.0
Base URL
https://api.structify.ai
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Structify admin API declares 2 security schemes for authenticating requests. An API key is passed in the header as api_key (api_key). It accepts HTTP bearer tokens (session_token). By default, every request must be authenticated.

Paths & Operations 55

Across 49 paths, the API surfaces 55 operations — 3 DELETE, 16 GET, 5 PATCH, 28 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

admin 55

Admin endpoints

GET
/admin/chat/templates
admin_list_chat_templates 1 param → 200500
POST
/admin/chat/templates
admin_create_chat_template body → 200400403404500
PATCH
/admin/chat/templates/{template_id}
admin_update_chat_template 1 param body → 200404500
POST
/admin/connector-catalog
Create a new connector catalog entry
admin_create_connector_catalog body → 200
POST
/admin/connector-catalog/auth-methods
Create a new connector auth method
admin_create_connector_auth_method body → 200
PATCH
/admin/connector-catalog/auth-methods/{id}
Update a connector auth method
admin_update_connector_auth_method 1 param body → 200
POST
/admin/connector-catalog/credential-fields
Create a new connector credential field
admin_create_connector_credential_field body → 200
POST
/admin/connector-catalog/credential-fields/batch
Batch create connector credential fields
admin_batch_create_connector_credential_fields body → 200
DELETE
/admin/connector-catalog/credential-fields/{id}
Delete a connector credential field
admin_delete_connector_credential_field 1 param → 200404
PATCH
/admin/connector-catalog/credential-fields/{id}
Update a connector credential field
admin_update_connector_credential_field 1 param body → 200
GET
/admin/connector-catalog/nango-pending
List Nango integrations that are not yet in the connector catalog
admin_list_nango_pending → 200
GET
/admin/connector-catalog/scopes
admin_list_connector_auth_method_scopes 1 param → 200
POST
/admin/connector-catalog/scopes
admin_create_connector_auth_method_scope body → 200
POST
/admin/connector-catalog/scopes/batch
admin_batch_create_connector_auth_method_scopes body → 200
DELETE
/admin/connector-catalog/scopes/{id}
admin_delete_connector_auth_method_scope 1 param → 200404
PATCH
/admin/connector-catalog/scopes/{id}
admin_update_connector_auth_method_scope 1 param body → 200404
DELETE
/admin/connector-catalog/{id}
admin_delete_connector_catalog 1 param → 200404
PATCH
/admin/connector-catalog/{id}
Update a connector catalog entry
admin_update_connector_catalog 1 param body → 200
PUT
/admin/connector-catalog/{slug}/logo
admin_upload_connector_logo 1 param body → 200
POST
/admin/connector/clone
admin_clone_connectors body → 200401404
POST
/admin/connector/datahub-config
admin_set_connector_datahub_config body → 200401404
GET
/admin/connector/team/{team_id}
admin_list_team_connectors 1 param → 200401
POST
/admin/critical
admin_report_critical body → 200401
GET
/admin/dataset/get_by_id
admin_dataset_get_by_id 1 param → 200404
POST
/admin/functional_tests/create
Create a new functional test
admin_create_functional_test body → 200400500
POST
/admin/functional_tests/link
Link a chat session to a functional test
admin_link_chat_to_functional_test body → 200400500
GET
/admin/functional_tests/list
List all functional tests
admin_list_functional_tests → 200500
GET
/admin/functional_tests/results
Get results for a functional test or sample
admin_get_functional_test_results 2 params → 200400500
GET
/admin/functional_tests/system_prompt
Get the system prompt template
admin_get_system_prompt → 200500
PUT
/admin/functional_tests/update_results
Update results for a chat linked to a functional test
admin_update_functional_test_results body → 200400404500
GET
/admin/jobs/concurrency_limits
admin_get_job_concurrency_limits → 200
PUT
/admin/jobs/concurrency_limits
admin_update_job_concurrency_limits body → 200
POST
/admin/jobs/delete
admin_jobs_delete body → 200400
POST
/admin/jobs/kill_by_user
admin_kill_jobs_by_user body → 200
GET
/admin/jobs/list
admin_jobs_list 5 params → 200
GET
/admin/jobs/running_stats
admin_get_running_job_stats → 200
POST
/admin/redis/flush
admin_redis_flush → 200500
POST
/admin/sandbox/create_job
admin_sandbox_create_job body → 200
GET
/admin/sandbox/list
admin_sandbox_list 2 params → 200
POST
/admin/sandbox/{sandbox_id}/terminate
admin_sandbox_terminate 1 param → 200
POST
/admin/team/add_member
admin_team_add_member body → 200
POST
/admin/team/cancel_subscription
admin_team_cancel_subscription body → 200
POST
/admin/team/create_subscription
admin_team_create_subscription body → 200
POST
/admin/team/expire_grants
admin_team_expire_grants body → 200
POST
/admin/team/extend_trial
admin_team_extend_trial body → 200
GET
/admin/team/get/{team_id}
admin_team_get 1 param → 200404500
POST
/admin/team/grant_credits
admin_team_grant_credits body → 200
GET
/admin/team/list
Gets all the teams with their subscription status, grants, and member counts.
admin_team_list 3 params → 200
POST
/admin/team/remove_member
admin_team_remove_member body → 200
POST
/admin/team/update_seats_override
admin_team_update_seats_override body → 200
GET
/admin/team/{team_id}/members
admin_team_list_members 1 param → 200
POST
/admin/users/create
Create a user, returning their session token.
admin_user_create body → 200
POST
/admin/users/get_stats
admin_user_stats body → 200
POST
/admin/users/impersonate
admin_impersonate_user body → 200400401500
GET
/admin/users/list
Lists all users with their team memberships.
admin_user_list → 200

Schemas 154

The contract defines 154 schemas that model the data the API accepts and returns. The most detailed are User (26 properties), Connector (19 properties), Team (15 properties), Sandbox (14 properties). Each schema is shown below with its type and property counts.

TeamListResponse
CreateJobSandboxResponse
object
4 properties 3 required
UpdateConnectorAuthMethodRequest
object
3 properties
Membership
object
Contains membership information and API token value
12 properties 6 required
AdminCreateSubscriptionResponse
object
3 properties 3 required
CancelSubscriptionResponse
object
2 properties 2 required
UpdateConnectorCredentialFieldRequest
object
8 properties
FunctionalTestResultsResponse
object
3 properties 1 required
BatchCreateScopesResponse
object
1 property 1 required
TeamSubscriptionInfo
object
5 properties 4 required
ExpireGrantsRequest
object
2 properties 2 required
ScrapePageInput
object
3 properties 3 required
LinkChatToFunctionalTestRequest
object
4 properties 4 required
ExplorationPhaseId
Identifies the phase of connector exploration This enum is used to track which phase of exploration a chat session belongs to. It's stored as JSONB in the data…
RequiredEntity
object
2 properties 1 required
ConnectorCredentialFieldId
string
CloneConnectorItem
object
3 properties 3 required
CancelSubscriptionRequest
object
1 property 1 required
CreateConnectorAuthMethodRequest
object
6 properties 4 required
DatahubSecretMap
object
Maps DatahubIngestionKey to the name of the connector secret that holds the value.
ConnectorAuthMethodId
string
ConnectorCatalog
object
10 properties 7 required
RequiredProperty
object
2 properties 2 required
SaveRequirement
It's an OR statement across these.
BatchCreateScopesRequest
object
1 property 1 required
TeamMember
object
6 properties 5 required
Input
MembershipId
string
ImpersonateResponse
object
4 properties 4 required
BasicPropValue
Connector
object
19 properties 8 required
MergeStrategy
TeamRole
string
JobConcurrencyLimits
object
9 properties 2 required
AdminDeleteJobsRequest
object
1 property 1 required
UserJobCount
object
4 properties 4 required
AdminRemoveMemberResponse
object
1 property 1 required
ConnectorId
string
ExpireGrantsResponse
object
2 properties 2 required
PendingNangoIntegration
object
4 properties 2 required
WorkflowBucket
object
2 properties 1 required
UpdateFunctionalTestResultsRequest
object
4 properties 4 required
JobStatus
string
LLMRelationship
object
4 properties 3 required
PDFIngestor
object
Ingest all pages of a PDF and process them independently.
2 properties 1 required
CreateFunctionalTestRequest
object
3 properties 1 required
LLMEntity
object
3 properties 3 required
TimeBucket
string
CreateConnectorCatalogRequest
object
7 properties 2 required
UserParams
object
7 properties
ConnectorTableId
string
TemplateQuestion
object
2 properties 1 required
ChatSessionId
string
FunctionalTestListItem
object
6 properties 4 required
ReportCriticalRequest
object
1 property 1 required
UploadConnectorLogoResponse
object
1 property 1 required
BatchCreateCredentialFieldsRequest
object
1 property 1 required
ConnectorExplorationInput
object
4 properties 4 required
ChatTemplateId
string
PropertyDescriptor
object
4 properties 2 required
UpdateChatTemplate
object
7 properties
JobType
string
UserMembershipInfo
object
4 properties 4 required
ExplorationRunId
string
ConnectorCategory
string
ExtendTrialResponse
object
3 properties 3 required
TokenResponse
object
4 properties 4 required
RequiredRelationship
object
1 property 1 required
UserSessionId
string
AdminAddMemberRequest
object
3 properties 3 required
WorkflowSessionNodeId
string
StripeEventId
string
ImpersonateRequest
object
1 property 1 required
LLMKnowledgeGraph
object
Knowledge graph info structured to deserialize and display in the same format that the LLM outputs. Also the first representation of an LLM output in the pipel…
2 properties 1 required
GrantCreditsRequest
object
6 properties 3 required
CloneConnectorsResponse
object
1 property 1 required
CreateConnectorCredentialFieldRequest
object
9 properties 5 required
AdminCreateSubscriptionRequest
object
7 properties 4 required
InputType
RelationshipMergeProbability
object
2 properties
AdminDatasetReturn
ConnectorCredentialField
object
12 properties 8 required
ConnectorDatabaseId
string
DatahubIngestionInput
object
3 properties 3 required
ScrapePageUrlInput
object
3 properties 3 required
WebSearch
object
3 properties
AdminRemoveMemberRequest
object
2 properties 2 required
ConnectorAuthMethodScopeId
string
UserListResponse
User
object
26 properties 11 required
TeamVisibility
string
SubscriptionTier
string
Represents the different subscription tiers available
UpdateSeatsOverrideResponse
object
2 properties 1 required
CreateChatTemplateRequest
object
7 properties 7 required
RunningJobStats
object
6 properties 6 required
FunctionalTestResult
object
3 properties 3 required
MergeConfig
object
The configuration for a probabilistic merge strategy
3 properties 2 required
CreditGrantId
string
UpdateConnectorAuthMethodScope
object
4 properties
ConnectorSchemaId
string
ChatTemplate
object
12 properties 12 required
GrantCreditsResponse
object
3 properties 3 required
DatasetId
string
UpdateConnectorCatalogRequest
object
6 properties
ListScopesResponse
object
1 property 1 required
TeamId
string
PaginatedTeamListResponse
object
2 properties 2 required
SandboxId
string
EntityId
string
ComparisonStrategy
string
AdminAddMemberResponse
object
1 property 1 required
ConnectorAuthType
string
ExplorationStrategy
string
SandboxProvider
string
AdminListMembersResponse
object
1 property 1 required
JobId
string
Team
object
15 properties 4 required
CreateConnectorAuthMethodScopeRequest
object
5 properties 2 required
UserId
string
DaytonaCredentials
object
2 properties
DatasetDescriptor
object
A dataset is where you put multiple referential schemas. A dataset is a complete namespace where all references between schemas are held within the dataset.
5 properties 4 required
SandboxStatus
string
GetUserStatsParams
object
5 properties
Permission
string
AdminListConnectorsResponse
object
1 property 1 required
CreateJobSandboxRequest
object
1 property 1 required
KillByUserResponse
object
1 property 1 required
UploadConnectorLogoForm
object
1 property 1 required
FeatureFlag
string
TableDescriptor
object
The full definition of what a schema is - without duplicate information.
5 properties 3 required
JobTypeCount
object
2 properties 2 required
PropertyType
FunctionalTestId
string
FlushResponse
object
2 properties 2 required
JobStats
object
2 properties 2 required
UpdateSeatsOverrideRequest
object
2 properties 1 required
ConnectorAuthMethodScope
object
8 properties 8 required
ConnectorAuthMethod
object
9 properties 7 required
Sandbox
object
14 properties 7 required
KillByUserRequest
object
1 property 1 required
CreditGrant
object
11 properties 7 required
ListJobsResponse
object
11 properties 5 required
RelationshipDescriptor
object
6 properties 4 required
UpdateJobConcurrencyLimits
object
7 properties
ExtendTrialRequest
object
2 properties 2 required
DatahubIngestionType
string
SetDatahubConfigRequest
object
3 properties 1 required
RelationshipMergeStrategy
JobInput
object
6 properties 3 required
ConnectorCatalogId
string
AdminDeleteJobsResponse
object
1 property 1 required
UserType
string
CloneConnectorsRequest
object
4 properties 4 required
FunctionalTest
object
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

structify-admin-api-openapi.yml Raw ↑

Other APIs Structify publishes across the network.

Structify account API
Structify chat API
Structify chat_templates API
Structify code API
Structify connector_catalog API
Structify connectors API
Structify dataset API
Structify documents API
Structify entity API
Structify jobs API
Structify match API
Structify Nango API
Where this information came from

This is an independent, third-party profile of Structify admin API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.