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

Pay-i KP Is API is one of 14 APIs that Pay-i publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include KPIs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and rate-limit docs.

This API exposes 8 operations across 5 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.pay-i.com.

8 operations 5 paths 12 schemas 1 DELETE4 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.pay-i.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Pay-i KP Is API declares 1 security scheme for authenticating requests. An API key is passed in the header as xProxy-api-key (Pay_I_API_Key). By default, every request must be authenticated.

  • Pay_I_API_Key — Pay-I API Key. Example: "{apikey}"

Paths & Operations 8

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

KPIs 8

KPIs

GET
/api/v1/use_cases/definitions/{use_case_name}/kpis
Get all KPIs for a Use Case
getKpi 5 params → 200400401404
POST
/api/v1/use_cases/definitions/{use_case_name}/kpis
Create a new KPI definition for a Use Case
createUseCaseKpiDefinition 1 param body → 200400401403404
GET
/api/v1/use_cases/definitions/{use_case_name}/kpis/{kpi_name}
Get a KPI definition for a Use Case
getUseCaseKpiDetails 2 params → 200400401404
DELETE
/api/v1/use_cases/definitions/{use_case_name}/kpis/{kpi_name}
Delete a KPI definition for a Use Case
deleteUseCaseKpiDefinition 2 params → 200400401404
PUT
/api/v1/use_cases/definitions/{use_case_name}/kpis/{kpi_name}
Update a KPI definition for a Use Case
updateUseCaseKpiDefinition 2 params body → 200400401404
PUT
/api/v1/use_cases/instances/{use_case_name}/{use_case_id}/kpis/{kpi_name}
Update a KPI on a Use Case instance
updateUseCaseInstanceKpi 3 params body → 200400401404
GET
/api/v1/use_cases/instances/{use_case_name}/{use_case_id}/kpis
Return all KPI scores for a Use Case instance
getUseCaseInstanceKpis 6 params → 200400401404
GET
/api/v1/use_cases/instances/{use_case_name}/{use_case_id}/value
Get the value score (money and/or time) for a Use Case instance
getUseCaseInstanceValue 2 params → 200400401404

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are PayI.Calculator.Models.KpiResponse (7 properties), Microsoft.AspNetCore.Mvc.ProblemDetails (5 properties), PayI.Calculator.Models.KpiScoreResponse (5 properties), PayI.Calculator.Models.CreateKpiRequest (4 properties). Each schema is shown below with its type and property counts.

Microsoft.AspNetCore.Mvc.ProblemDetails
object
5 properties
PayI.Calculator.Models.UpdateKpiRequest
object
2 properties
PayI.Calculator.Models.KpiType
string
PayI.Calculator.Models.KpiScoreResponse
object
5 properties 1 required
PayI.Common.Models.ApiError
object
3 properties 2 required
PayI.Calculator.Models.KpiResponse
object
7 properties 3 required
PayI.Calculator.Models.ApiQueries.PaginatedCursorKpiResponseList
object
3 properties
PayI.Calculator.Models.KpiScoreRequest
object
1 property
PayI.Calculator.Models.CreateKpiRequest
object
4 properties 4 required
PayI.Common.Models.ProxyError
object
2 properties
PayI.Calculator.Models.ApiQueries.PaginatedKpiScoreResponseList
object
3 properties
PayI.Calculator.Models.ValueScoreResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pay-i-kpis-api-openapi.yml Raw ↑

Other APIs Pay-i publishes across the network.

Pay-i Anthropic Requests API
Pay-i AWS Bedrock Requests API
Pay-i Azure Anthropic Requests API
Pay-i Azure OpenAI Requests API
Pay-i Categories API
Pay-i Google Vertex Requests API
Pay-i Ingest Events API
Pay-i Limits API
Pay-i OpenAI Requests API
Pay-i Reports API
Pay-i Requests API
Pay-i Resources API
Where this information came from

This is an independent, third-party profile of Pay-i KP Is 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.