Name API
Description
Generate a name for a person.
Endpoint
> GET https://api.jsonrepo.com/v1/compute/generator/name
Headers
Field | Description |
---|---|
api_key | Required Your API Key |
Parameters
Field | Type | Description |
---|---|---|
gender | String | Optional Gender seed for the generated name Default: random Accepts: male , female |
Response
A successful request will result in a populated payload
field with the expected output.
A failed request will result in an error output as detailed in Error Rules. If the endpoint validation fails due to missing, badly formatted or invalid parameters, the endpoint will return HTTP code 400
along with a message
detailing the error.
See the examples section for more information.
Request
- Curl
// Generate a `male` name
curl -G \
https://api.jsonrepo.com/v1/compute/generator/name \
-H "api_key: {YOUR_API_KEY_HERE}" \
--data-urlencode "gender=male"
Success Response
{
"http_code": 200,
"http_message": "Ok",
"message": "Successful execution",
"payload": {
"name": {
"first_name": "Chandler",
"last_name": "Doyle",
"full_name": "Chandler Doyle",
"gender": "male"
}
}
}
Error Response Example
// Request with invalid `gender` parameter
{
"http_code": 400,
"http_message": "Bad Request",
"message": "Malformed request: `gender` parameter provided must be `male` or `female`.",
"payload": []
}