Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Xiaoman (OKKI) Companies API

The Companies API from Xiaoman (OKKI) — 4 operation(s) for companies.

Xiaoman (OKKI) Companies API is one of 7 APIs that Xiaoman (OKKI) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Companies. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 4 operations across 4 paths, and defines 1 schema. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://go.okki.ai.

4 operations 4 paths 1 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api-sandbox.xiaoman.cn
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Xiaoman (OKKI) Companies API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiKey).

  • apiKey — Authorization: ApiKey sk-your-key-here — API keys issued at https://go.okki.ai after registration.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Companies 4
POST
/api/v1/companies/search-advanced
Search companies (advanced profile search)
searchCompaniesAdvanced body → 200400401429
POST
/api/v1/companies/unlock
Unlock a company (resolve domain to companyHashId)
unlockCompany body → 200402404429
GET
/api/v1/companies/{companyHashId}/profile
Get an unlocked company profile
getCompanyProfile 1 param → 200404429
GET
/api/v1/companies/{companyHashId}/profileEmails
Get contact emails for an unlocked company
getCompanyProfileEmails 4 params → 200404429

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Problem (6 properties). Each schema is shown below with its type and property counts.

Problem
object
RFC 7807 Problem Details error envelope.
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xiaoman-companies-api-openapi.yml Raw ↑

Other APIs Xiaoman (OKKI) publishes across the network.

Xiaoman (OKKI) Contacts API
Xiaoman (OKKI) Credits API
Xiaoman (OKKI) 产品 API
Xiaoman (OKKI) devops相关 API
Xiaoman (OKKI) Emails API
Xiaoman (OKKI) s7.1 API