Ballerina · Example Payload
Central Api Package Docs Example
IntegrationOrchestrationOpen SourceProgramming LanguagePackage RegistryDeveloper ToolsCode GenerationAgent Skills
Central Api Package Docs Example is an example object payload from Ballerina, with 3 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
apiDocsVersiondocsDatasearchData
Example Payload
{
"apiDocsVersion": "1.0.0",
"docsData": {
"releaseVersion": "",
"langLibs": [],
"modules": [
{
"relatedModules": [],
"records": [],
"classes": [],
"objectTypes": [],
"serviceTypes": [],
"clients": [],
"listeners": [],
"functions": [
{
"accessor": "",
"resourcePath": "",
"isIsolated": true,
"isRemote": false,
"isResource": false,
"isExtern": false,
"parameters": [],
"returnParameters": [
{
"type": {
"name": "float",
"category": "builtin",
"isAnonymousUnionType": false,
"isInclusion": false,
"isArrayType": false,
"isNullable": false,
"isOptional": false,
"isTuple": false,
"isIntersectionType": false,
"isParenthesisedType": false,
"isTypeDesc": false,
"isRestParam": false,
"isDeprecated": false,
"isPublic": false,
"generateUserDefinedTypeLink": true,
"memberTypes": [],
"arrayDimensions": 0
},
"name": "",
"description": "Selected random value\n",
"isDeprecated": false,
"isReadOnly": false
}
],
"annotationAttachments": [],
"name": "createDecimal",
"description": "Generates a random decimal number between 0.0 and 1.0.\n```ballerina\nfloat randomValue = random:createDecimal();\n```\n\n",
"descriptionSections": [],
"isDeprecated": false,
"isReadOnly": false
},
{
"accessor": "",
"resourcePath": "",
"isIsolated": true,
"isRemote": false,
"isResource": false,
"isExtern": false,
"parameters": [
{
"defaultValue": "",
"type": {
"name": "int",
"category": "builtin",
"isAnonymousUnionType": false,
"isInclusion": false,
"isArrayType": false,
"isNullable": false,
"isOptional": false,
"isTuple": false,
"isIntersectionType": false,
"isParenthesisedType": false,
"isTypeDesc": false,
"isRestParam": false,
"isDeprecated": false,
"isPublic": false,
"generateUserDefinedTypeLink": true,
"memberTypes": [],
"arrayDimensions": 0
},
"name": "startRange",
"description": "Range start value\n",
"isDeprecated": false,
"isReadOnly": false
},
{
"defaultValue": "",
"type": {
"name": "int",
"category": "builtin",
"isAnonymousUnionType": false,
"isInclusion": false,
"isArrayType": false,
"isNullable": false,
"isOptional": false,
"isTuple": false,
"isIntersectionType": false,
"isParenthesisedType": false,
"isTypeDesc": false,
"isRestParam": false,
"isDeprecated": false,
"isPublic": false,
"generateUserDefinedTypeLink": true,
"memberTypes": [],
"arrayDimensions": 0
},
"name": "endRange",
"description": "Range end value\n",
"isDeprecated": false,
"isReadOnly": false
}
],
"returnParameters": [
{
"type": {
"isAnonymousUnionType": true,
"isInclusion": false,
"isArrayType": false,
"isNullable": false,
"isOptional": false,
"isTuple": false,
"isIntersectionType": false,
"isParenthesisedType": false,
"isTypeDesc": false,
"isRestParam": false,
"isDeprecated": false,
"isPublic": false,
"generateUserDefinedTypeLink": true,
"memberTypes": [
{
"name": "int",
"category": "builtin",
"isAnonymousUnionType": false,
"isInclusion": false,
"isArrayType": false,
"isNullable": false,
"isOptional": false,
"isTuple": false,
"isIntersectionType": false,
"isParenthesisedType": false,
"isTypeDesc": false,
"isRestParam": false,
"isDeprecated": false,
"isPublic": false,
"generateUserDefinedTypeLink": true,
"memberTypes": [],
"arrayDimensions": 0
},
{
"orgName": "ballerina",
"moduleName": "random",
"version": "1.7.0",
"name": "Error",
"category": "errors",
"isAnonymousUnionType": false,
"isInclusion": false,
"isArrayType": false,
"isNullable": false,
"isOptional": false,
"isTuple": false,
"isIntersectionType": false,
"isParenthesisedType": false,
"isTypeDesc": false,
"isRestParam": false,
"isDeprecated": false,
"isPublic": false,
"generateUserDefinedTypeLink": true,
"memberTypes": [],
"arrayDimensions": 0
}
],
"arrayDimensions": 0
},
"name": "",
"description": "Selected random value or else, a `random:Error` if the start range is greater than the end range\n",
"isDeprecated": false,
"isReadOnly": false
}
],
"annotationAttachments": [],
"name": "createIntInRange",
"description": "Generates a random number between the given start(inclusive) and end(exclusive) values.\nPlease note that the generated number is not cryptographically secured.\n```ballerina\nint randomInteger = check random:createIntInRange(1, 100);\n```\n\n",
"descriptionSections": [],
"isDeprecated": false,
"isReadOnly": false
}
],
"constants": [],
"annotations": [],
"errors": [
{
"detailType": {
"orgName": "ballerina",
"moduleName": "random",
"version": "1.7.0",
"name": "Error",
"category": "errors",
"isAnonymousUnionType": false,
"isInclusion": false,
"isArrayType": false,
"isNullable": false,
"isOptional": false,
"isTuple": false,
"isIntersectionType": false,
"isParenthesisedType": false,
"isTypeDesc": false,
"isRestParam": false,
"isDeprecated": false,
"isPublic": false,
"generateUserDefinedTypeLink": true,
"memberTypes": [],
"arrayDimensions": 0
},
"isDistinct": true,
"name": "ArithmeticError",
"description": "Represents the arithmetic error.\n",
"descriptionSections": [],
"isDeprecated": false,
"isReadOnly": false
},
{
"isDistinct": true,
"name": "Error",
"description": "Represents Random module related errors.\n",
"descriptionSections": [],
"isDeprecated": false,
"isReadOnly": false
}
],
"types": [],
"unionTypes": [],
"simpleNameReferenceTypes": [],
"tupleTypes": [],
"tableTypes": [],
"mapTypes": [],
"intersectionTypes": [],
"typeDescriptorTypes": [],
"functionTypes": [],
"streamTypes": [],
"arrayTypes": [],
"anyDataTypes": [],
"anyTypes": [],
"stringTypes": [],
"integerTypes": [],
"decimalTypes": [],
"xmlTypes": [],
"booleanTypes": [],
"enums": [],
"variables": [],
"configurables": [],
"resources": [],
"id": "random",
"summary": "This module provides APIs to generate pseudo-random numbers.\n",
"description": "## Overview\n\nThis module provides APIs to generate pseudo-random numbers.\n\nThe generated values are selected pseudo-randomly with uniform distribution from a particular range.\n\nFor information on the operations, which you can perform with the `random` module, see the below **Functions**.\n",
"orgName": "ballerina",
"version": "1.7.0",
"isDefaultModule": true
}
]
},
"searchData": {
"modules": [
{
"id": "random",
"description": "This module provides APIs to generate pseudo-random numbers.\n",
"orgName": "ballerina",
"version": "1.7.0",
"isDefaultModule": true
}
],
"classes": [],
"functions": [
{
"id": "createDecimal",
"description": "Generates a random decimal number between 0.0 and 1.0.\n```ballerina\nfloat randomValue = random:createDecimal();\n```\n\n",
"moduleId": "random",
"moduleOrgName": "ballerina",
"moduleVersion": "1.7.0"
},
{
"id": "createIntInRange",
"description": "Generates a random number between the given start(inclusive) and end(exclusive) values.\nPlease note that the generated number is not cryptographically secured.\n```ballerina\nint randomInteger = check random:createIntInRange(1, 100);\n```\n\n",
"moduleId": "random",
"moduleOrgName": "ballerina",
"moduleVersion": "1.7.0"
}
],
"records": [],
"constants": [],
"errors": [
{
"id": "ArithmeticError",
"description": "Represents the arithmetic error.\n",
"moduleId": "random",
"moduleOrgName": "ballerina",
"moduleVersion": "1.7.0"
},
{
"id": "Error",
"description": "Represents Random module related errors.\n",
"moduleId": "random",
"moduleOrgName": "ballerina",
"moduleVersion": "1.7.0"
}
],
"types": [],
"clients": [],
"listeners": [],
"annotations": [],
"objectTypes": [],
"enums": []
}
}
Work with this as data
Every example here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for examples
4 MCP tools reach this
find_examplesBrowse and filter every example in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This example
curl "https://apis.io/api/v1/examples/central-api-package-docs-example"
All examples
curl "https://apis.io/api/v1/examples?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.